Documente Academic
Documente Profesional
Documente Cultură
GFK-1260H
July 2001
Warning notices are used in this publication to emphasize that hazardous voltages, currents, temperatures, or other conditions that could cause personal injury exist in the equipment or may be associated with its use. In situations where inattention could cause either personal injury or damage to equipment, a Warning notice is used.
Caution provides information when careful attention must be taken in order to avoid damaging results.
Note calls attention to information that is especially significant to understanding and operating the equipment. Tip provides a suggestion. Guide provides additional directions for selected topics. This document is based on information available at the time of publication. While efforts have been made to be accurate, the information contained herein does not purport to cover all details or variations in hardware or software, nor to provide for every possible contingency in connection with installation, operation, or maintenance. Features may be described herein which are not present in all hardware and software systems. GE Fanuc Automation assumes no obligation of notice to holders of this document with respect to changes subsequently made. GE Fanuc Automation makes no representation of warranty, expressed, implied, or statutory with respect to, and assumes no responsibility for the accuracy, completeness, sufficiency, or usefulness of the information contained herein. No warranties of merchantability or fitness for purpose shall apply.
CIMPLICITY is a registered trademark of GE Fanuc Automation North America, Inc. Windows NT, Windows 98 and Windows 2000 are registered trademarks of Microsoft Corporation
ii
GFK-1260H
Preface
Related Publications
For more information, refer to these publications: CIMPLICITY HMI Plant Edition Base System User's Manual (GFK-1180)
GFK-1260H
iii
Contents
Introducing Trends 1-1
Trend Introduction ................................................................................................................. 1-1 About Trends.......................................................................................................................... 1-1 Trend Chart Display............................................................................................................... 1-2 Runtime Action Options......................................................................................................... 1-5 Changing Chart Properties at Runtime..................................................................... 1-5 Zooming into a Specific Area .................................................................................. 1-6 Analyzing Data at a Selected Point in Time............................................................. 1-7 Scrolling Lines Forward and Backward ................................................................... 1-8
2-1
About Trend Chart Configuration .......................................................................................... 2-1 Inserting a Trend Chart Control Chart ..................................................................... 2-1 Resizing a New Trend Control Chart....................................................................... 2-3 The CIMPLICITY Trend Chart Properties Dialog Box......................................................... 2-5 Opening the CIMPLICITY Trend Chart Properties Dialog Box ............................. 2-5 Trend Control Line................................................................................................................. 2-6 Using Quick Lines to Create a Trend Chart Line..................................................... 2-7 Creating a New Trend Chart Line (Overview of Detailed Method)......................... 2-8 Configuring a Point Line........................................................................................ 2-10 Configuring an Expression Line............................................................................. 2-11 Configuring a Logged Line .................................................................................... 2-12 Configuring a Logged Expression Line ................................................................. 2-13 Configuring a CSV File Line ................................................................................. 2-15 Configuring a Reference Line ................................................................................ 2-17 Specifying Line Display Features .......................................................................... 2-21 Mapping Axes to a Line......................................................................................... 2-25 Axis Configuration ............................................................................................................... 2-27 Configuring the X-axis........................................................................................... 2-27 Configuring the Y-axis........................................................................................... 2-32 Chart Properties.................................................................................................................... 2-37 Configuring Basic Chart Properties ....................................................................... 2-37 Configuring Advanced Chart Properties ................................................................ 2-39 Legend Properties................................................................................................................. 2-42 Grid Properties ..................................................................................................................... 2-44 Runtime Actions................................................................................................................... 2-46 Array Point Trends............................................................................................................... 2-47 Color and Font Choices on a Trend Chart............................................................................ 2-48 Selecting a Basic Color .......................................................................................... 2-48 Creating a Custom Color........................................................................................ 2-49 Modifying a Color.................................................................................................. 2-50 Choosing a Font ..................................................................................................... 2-51
GFK-1260H
Contents-v
3-1
About Trend Methods ............................................................................................................ 3-1 Method Configuration ............................................................................................................ 3-4 Step1. Name a Trend Control................................................................................... 3-4 Step 2. Create an Invoke Method Action ................................................................. 3-4 Line Display Methods ............................................................................................................ 3-8 AddDynPointLine Method ....................................................................................... 3-8 AddExpressionLine Method .................................................................................. 3-10 AddLoggedLine Method ........................................................................................ 3-11 AddLoggedExpressionLine Method ...................................................................... 3-13 DeleteTrendLine Method ....................................................................................... 3-15 SetLineAutoupdate................................................................................................. 3-16 SetLineCompression Method ................................................................................. 3-18 SetLineDisplay Method.......................................................................................... 3-20 SetLineVisible Method .......................................................................................... 3-24 WriteReferenceFile Method................................................................................... 3-26 Legend Methods ................................................................................................................... 3-28 SetLegendState Method ......................................................................................... 3-28 Axis Methods ....................................................................................................................... 3-30 SetAxisTicks Method............................................................................................. 3-30 X-axis (Time Related) Methods ........................................................................................... 3-31 JumpToCurrentTime Method................................................................................. 3-31 PauseUpdates Method............................................................................................ 3-33 ScrollLines Method................................................................................................ 3-34 SetXDuration Method ............................................................................................ 3-35 SetXStartTime Method .......................................................................................... 3-37 Y-axis Methods .................................................................................................................... 3-39 SetAxisLabel Method............................................................................................. 3-39 SetLineYAxis Method............................................................................................ 3-40 SetYAxisVisible Method ....................................................................................... 3-42 SetLineUseChartY Method .................................................................................... 3-44 Visual Aid Methods.............................................................................................................. 3-46 ResetZoom Method................................................................................................ 3-46 SetGridState Method.............................................................................................. 3-47 Wait State Methods and Events............................................................................................ 3-48 EnableOutstandingLoggedRequestStateEvent Method .......................................... 3-49 DisableOutstandingLoggedRequestStateEvent Method......................................... 3-50 EnteringOutstandingLoggedRequestState Event.................................................... 3-51 LeavingOutstandingLoggedRequestState Event .................................................... 3-52 Using Wait State Functionality Example ............................................................... 3-52 Other Trend Methods ........................................................................................................... 3-61 AboutBox Method.................................................................................................. 3-61 ForceRedraw Method............................................................................................. 3-61 SetCimplicityProject Method................................................................................. 3-62
4-1
About Quick Trends ............................................................................................................... 4-1 Starting Quick Trends .............................................................................................. 4-2 Configuring a Quick Trend Chart ............................................................................ 4-3 Using Popup Menus to Make Quick Changes.......................................................... 4-4
Index-vi
GFK-1260H
Introducing XY Plots
5-1
Designing an XY Plot
6-1
About XY Plot Design ........................................................................................................... 6-1 Inserting an XY Plot Control ................................................................................... 6-2 Resizing a New XY Plot Control ............................................................................. 6-3 Opening the CIMPLICITY XY Plot Properties Dialog Box ................................... 6-4 Color and Font Choices for an XY Plot Control .................................................................... 6-6 Selecting a Basic Color ............................................................................................ 6-6 Creating a Custom Color.......................................................................................... 6-6 Modifying a Color.................................................................................................... 6-8 Choosing a Font ....................................................................................................... 6-9 XY Plot Foreground, Background and Chart Colors ........................................................... 6-10 XY Plot Axes Properties ...................................................................................................... 6-12 Finding the Axes Properties ................................................................................... 6-12 Designing XY Plot Axes........................................................................................ 6-12 XY Plot Series Properties..................................................................................................... 6-22 Finding the Series Properties ................................................................................. 6-22 Designing a Series.................................................................................................. 6-22 XY Plot Slider Properties..................................................................................................... 6-29 Finding the Sliders Properties ................................................................................ 6-29 Designing a Slider.................................................................................................. 6-29 XY Plot Grid Properties....................................................................................................... 6-34 Finding the Grid Properties.................................................................................... 6-34 Designing the Grid ................................................................................................. 6-34 XY Plot Legend Properties .................................................................................................. 6-36 Finding the Legend Properties ............................................................................... 6-36 Designing the XY Plot Legends............................................................................. 6-36 XY Plot Title Properties....................................................................................................... 6-42 Finding the XY Plot Title Properties ..................................................................... 6-42 Designing an XY Plot Title.................................................................................... 6-42 XY Plot Updates .................................................................................................................. 6-44
Plotting XY Data
7-1
About Plotting XY Data......................................................................................................... 7-1 Creating a Series of Data Values ............................................................................. 7-1 Scripting Examples for XY Plots ........................................................................................... 7-3 Resizing Series Vectors ........................................................................................... 7-3 Setting Individual Data Values ................................................................................ 7-4 Pushing one or more Data Values ............................................................................ 7-6 Pushing Values from Points ..................................................................................... 7-9 Setting One or more Data Values........................................................................... 7-11 Setting Values from Points..................................................................................... 7-14
GFK-1260H
Contents
Contents-vii
8-1
About XY Plot SmartObjects ................................................................................................. 8-1 XY Plot SmartObject Placement ............................................................................................ 8-2 XY Plot SmartObject Configuration ...................................................................................... 8-3 Configuring the XY Plot SmartObject Series........................................................... 8-3 Configuring the XY Plot SmartObject Axes ............................................................ 8-6 Configuring an XY Plot SmartObject Name and Colors.......................................... 8-9 Configuring an XY SmartObject Grid ................................................................... 8-10 XY Plot SmartObject Enhancements.................................................................................... 8-11 Configuring an XY Plot 1 Example ....................................................................... 8-12 Configuring the Plot 2 Example............................................................................. 8-15
Index
Index-viii
GFK-1260H
Introducing Trends
Trend Introduction
CIMPLICITY HMI provides you with the ability to look at data from several different perspectives. The charts that enable you to do this are: Trend chartsIn which you can review, evaluate and log point values over time. XY chartsIn which you can plot values for one or more series, using two or more axes.
About Trends
CIMPLICITY HMI provides you with extensive capabilities to trend data that is in several different formats. You can trend: Runtime values Data from a CIMPLICITY Database Logger Combined runtime values and logged data Data from a .CSV file Data from a reference file that was created during runtime and can be recalled and displayed. This reference trend can be displayed and compared with other comparable data. Arrays CIMPLICITY HMI provides even more capability by letting you and / or a user: Display trends with: Multiple Y-axes so a user can display different parameter types in the same chart Data from different time periods so a user can compare different production periods in the same chart. Different time duration so that a user can compare production periods of differing length in the same chart. Auto update enabled so that the most recently logged data is automatically retrieved from disk while the trend is displayed. Zoom and pan through logged data to locate data of particular interest. Compare relative values with a slider that updates a legend with actual values. Display long time periods in compressed format where the plotted data is the average, minimum, maximum, first, or last element from a sample.
GFK-1260H
1-1
Line style / color X-axis ticks / numbersOptional Page scrollOptional Legend titleOptional Slider
Percent scroll
1-2
GFK-1260H
You can choose to display or hide: Display feature Ticks and numbers Grid Lines Legend Legend features Choose to Display or Hide For the Y-axis For the X-axis Gridlines Each line Entire legend Specific features: Title Line ID Y value at slider Engineering units Time at slider Date at slider Y-axis limits Current point value Array status Autoupdate status Status bar Status bar features Entire status bar Specific features: Status line Current date Current time Status title Slider date Slider time You can also specify how the charts many display features will appear. Display feature Chart area Chart background Grid Lines Other Configuration Options Choose the color Choose the color The number of horizontal and /or vertical lines Specify: Style Color Percent scroll buttons Page scroll buttons Fonts Specify the percent a line will scroll (forward / backward) when the buttons are pressed Specify to display or hide them Choose font, style and size You configure this powerful feature in CimEdit and display it in CimView. Because it is a CIMPLICITY HMI ActiveX control, it has an easy to use
GFK-1260H
Introducing Trends
1-3
CIMPLICITY Trend Control Properties dialog box. On six straightforward tabs, you can customize the trend chart exactly to your specifications.
1-4
GFK-1260H
Important: The changes you make remain in effect while the trend is being displayed. If you close the CimView window displaying the trend, then reopen it, the trend reverts to the original properties configured for it in CimEdit.
GFK-1260H
Introducing Trends
1-5
Note: While you are zoomed in, the auto update and run-time timers are ignored. The zoomed portion of the screen remains unchanged until you zoom out again, at which point new values are drawn and the timers are used again. To return to your normal chart display: 1. 2. 3. Place the mouse cursor in the chart area. Hold down the left mouse key and slide the mouse out of the trend control area. Lift the mouse button The chart redraws in normal mode.
1-6
GFK-1260H
Method 2Attach the chart slider to the most recent update data: Drag the slider off the right edge of the chart. The slider will then attach to the most recently plotted data and move as new values are plotted. Method 3Turn off the most recent update mode Do one of the following: Drag the slider to a new position. Zoom into an area. Display the CIMPLICITY Trend Control dialog box.
GFK-1260H
Introducing Trends
1-7
Scrolling Options
To scroll one page: Use the buttons to scroll backward or forward one page on the chart.
To scroll a percent of the visible chart: Use the buttons to move the line back or forward a specified percent.
The percent is specified by the trend control designer in the CIMPLICITY Trend Control Properties dialog box. (in the Scroll Percentage field in the Advanced dialog box on the Chart property tab)
Into the future Logged or CSV data Back to the past Into the future
1-8
GFK-1260H
B. Shares it's X-axis with another line, the axis labels displayed are based on the time span. 4. The space between the last element and the end of the chart is equal to the space between the first two elements. The type of array line you are scrolling determines how much information you see when you scroll. Scrolling also behaves differently for non-array and array data. Array Line Scrolled Current Back to the past You will see: Available array values that are closest to the new X-axis end time. No values will be displayed in a point line if the scroll is for the entire duration of the chart. No data because it has not been received yet. Available array values that are closest to the new X-axis end time, giving preference to runtime data. Array (logged) values if they are available in the database if the scroll is for the entire duration of the chart, No data because it has not been received yet. Available array values that are closest to the new X-axis end time. Array values if they are in the database. Only logged data if it is available for that future time span. Point arrays from the current time:
Into the future Logged array data: Current Back to the past Into the future
GFK-1260H
Introducing Trends
1-9
In addition, the CIMPLICITY Trend Control Properties dialog box provides you with tabs to customize every aspect of the trend chart. The tabs in the CIMPLICITY Trend Control Properties dialog box are: Page (This chapter) 6 27 37 42 44 46
Displays the associated point or expression data. Defines the X and Y axes on the Trend. Defines the chart characteristics of the Trend Defines the chart legend for the Trend. Defines the grid display for the Trend. Let you perform runtime actions when viewing the chart.
Place the ActiveX Placement cursor where you want the top left corner of the control to be located. You can move the control any time you want.
GFK-1260H
2-1
3. 4. 5.
Click the left mouse button. The Insert Object dialog box opens. Select the ActiveX tab. Select CIMPLICITY Trend Control.
6.
Click OK.
Result: A new Trend control is placed at the position you selected in your CimEdit screen when you use either method. The Trend control looks like this initially:
2-2
GFK-1260H
Method 1Quick 1. Grab one of the objects handles and move it.
Increase width
Method 2Precision 1. 2. Click Edit on the menu bar. Select Properties. Go to "Continue (after choosing from Methods 2-4)." Method 3-Precision Click the Properties button on the Format toolbar.
Go to "Continue (after choosing from Methods 2-4)." Method 4Precision 1. 2. Click the right mouse button on the Trend control. Select Properties from the popup menu. Go to "Continue (after choosing from Methods 2-4)."
GFK-1260H
2-3
Continue (after choosing from Methods 2-4) The Properties Object dialog box displays when you use Methods 2-4. 1. 2. Select the Geometry tab. Enter the width and / or height for the trend chart in the Width field and Height field.
Tip: Click the right mouse button in any area of the Trend control to display a popup menu that is related to that area.
2-4
GFK-1260H
Displays the associated point or expression data. Defines the X and Y axes on the Trend. Defines the chart characteristics of the Trend Defines the chart legend for the Trend. Defines the grid display for the Trend. Let you perform runtime actions when viewing the chart.
You do this entire configuration in the CIMPLICITY Trend Chart Properties dialog box. There are several methods for opening the CIMPLICITY Trend Chart Properties dialog box.
Method 3
Result: The CIMPLICITY Trend Control Properties dialog box opens when you use any method.
Note: Any fields that do not apply to the Trend you are defining will be dimmed.
GFK-1260H
2-5
Points. Expressions. Logged data. Logged Expressions. CSV files. Reference files.
Note: Engineering units only apply to Expression lines that contain one Point ID.
2-6
GFK-1260H
3. 4.
Click the Quick Lines button Select a Point ID. The Line ID:
Appears in the Line ID column with an associated color. Will appear on the legend. The line will be visible. 5. 6. (Optional) Click Display to open the Line Display dialog box and change the line display style. Either: Continue until you have all the lines that you need. Configure some lines with the detailed method.
GFK-1260H
2-7
Color palette. Line Display dialog box. Line Types Point (Expression) Logged Logged Point (Expression) .CSV Reference
Fields change based on Line type selection. Creates blank entry for new line. Copies selected line configuration. Deletes line. Move line up / down in list. Line - Axis Mapping dialog box. Quick Lines Opens Select a Point Browser.
3. 4. 5. 6.
A new entry appears in the Lines grid. Enter the required information for CIMPLICITY to associate data with that line type. See each line types section for more information. Either: A. Press Enter on the keyboard. B. Click the Line ID column The Line ID appears in the Lines grid.
2-8
GFK-1260H
7.
Specify line characteristics in the Lines grid. A. Select a color. Either: Click the Color Palette button (the color Palette opens.) or, Double-click a unique line color. B. (Optional) Check In Legend to list the name of the associated data in the Legend. C. Check Visible to make the line visible. on the line's row in the Color column
8. 9.
(Optional) Click Display to open the Line Display dialog box and change the line display style. Continue to add lines as follows: A. Click the New button line. to enter completely new information for another
to copy the selected line. You can then modify B. Click the Copy button the entry. This is particularly useful if you want to display variations in an expression. 10. Click the Delete button to delete any unnecessary lines.
arrows to move a selected point up or down in the list. The 11. Click the position in which it is displayed in the Properties dialog box is the position in which it is displayed in the Legend during runtime.
Note: If the Visible line option is cleared, the In Legend line option is ignored. This means that the line will not show up on the legend, unless the Legend show all chart option is checked. See "Configuring Advanced Chart Properties" in this chapter.
GFK-1260H
2-9
If the point is not being logged to either a data or group table, the trend line displays as current data becomes available.
Note: Using a logged expression line is preferable if you want the data to come from a data source that you choose, rather than the source chosen by the above order.
2-10
GFK-1260H
Edit Expression
Enter one or more Point IDs and mathematical operators that can be evaluated.
Expression menu
2.
Enter, in the Expression field, one or more Point IDs and mathematical operators that can be evaluated.
This feature is useful if you have two or more projects with the same Point ID (for example, BLDG_1 project and BLDG_2 project) and you want to be able to switch between them.
GFK-1260H
2-11
Important: Logging array points to Data log tables is currently not supported. As a result, trending array points from data log tables is not supported. Use group tables for array points.
1 2 3
2. 3.
Select the ODBC data source from the Datasource drop down menu. Open the Table/Point ID browser to select the: A. Table ID in the data source. B. Column ID in the table.
4.
Specify the update status in the Auto update check box: Check Clear Specify auto update. Keep the same historical information as a reference.
Logged lines can always be scrolled. If you uncheck Auto update, the line will update when it is scrolled.
Important: The source for a Logged line is always a column in a group log table. A group log table has one column per point, one row for all points. See the Using the Database Logger chapter in the CIMPLICITY HMI Base System User's Manual (GFK-1180) for more information.
2-12
GFK-1260H
Important: Logging array points to Data log tables is currently not supported. As a result, trending array points from data log tables is not supported. Use group tables for array points.
1 2 3 4
2. 3. 4.
Enter, in the Point Expression field, one or more Point IDs and mathematical operators that can be evaluated. Select the ODBC data source from the Datasource drop down menu. Open the Table/Column browser to select the: A. Table ID in the data source. B. Column ID in the table.
GFK-1260H
2-13
This feature is useful if you have two or more projects with the same Point ID (for example, BLDG_1 project and BLDG_2 project) and you want to be able to switch between them.
Note: One of the sources for a Logged expression line is always a column in a group log table. See the Using the Database Logger chapter in the CIMPLICITY HMI Base System User's Manual (GFK-1180) for more information
2-14
GFK-1260H
Name of .csv file containing the data Column ID in .csv file, up to 64 characters long
2. 3. 4. 5.
Open the Select a File dialog box. Select the .CSV file that contains the trend data Open the Table/Column browser. Select the column in the .CSV file that contains the trend data.
Guidelines for CSV files used by Trends include: 1. 2. Create a separate directory for your .CSV files. Give a CSV file used by Trends one of two formats. Choose the format, as follows: Format Common Time Stamp Unique Time Stamp 3. When All data has a common time stamp Each data column has a unique time stamp
The time stamp column(s) should use the date and time format indicated in the International settings on your Control Panel. In the examples here, the format is mm/dd/yy hh:mm:ss. Name columns using: Either case. Columns are not case sensitive. Up to 64 characters.
4.
5.
GFK-1260H
2-15
6.
Allow only the same data type within each column. Example of data type If: Then: The data type of the column Float All rows should have float values for that column.
7.
Give CSV files names that fit the 8.3 format. The ODBC Text driver cannot open a file with a filename greater than 12 characters. Example
Largest1.csv Can be a .CSV file name.
2-16
GFK-1260H
Enter one or more Point IDs and mathematical operators that can be evaluated.
Point browser
Point ID popup
B
Name of .REF file containing the data Column in group log table Select a File dialog box Table/Column browser
A Reference line is updated, as follows: Reference Line Value Source Expression How Trending Updates the Reference Line Trending takes the latest value of the expression and draws a horizontal line with the value. If the value of the expression changes, Trending updates the reference line. Retrieves values (from a reference file) that are exported into the reference file at runtime.
Reference file
GFK-1260H
2-17
Important: Reference files are currently available only on the Intel Windows NT platforms. To configure a reference file to be used for a reference line: 1. Select the Runtime Actions tab of the CIMPLICITY Trend Control Properties dialog box.
Check to enable Runtime action tab during runtime Export to reference file... enabled during runtime
2.
Make sure the Show property pages at runtime and Runtime actions check boxes are checked.
2-18
GFK-1260H
3.
During runtime: A. Double-click the Trend chart. The CIMPLICITY Trend Control Properties dialog box opens. B. Select the Runtime Actions tab. C. Click Export reference file The Save Reference File dialog box displays.
1 Click one or more lines to be referenced. 2 Find the folder in which the reference file will be located. 3 Name the file. 4 Click Save
D. Click each line in the Lines to Save box that you want to write to the reference file. E. Browse for the folder where you want to save the reference file in the Save in box. F. F. Enter the File name. Click Save to write the reference file, or click Cancel to cancel your request. When you click Save, all the data currently visible on the trend for the lines you selected will be written to the reference file.
Important: The ODBC Text driver cannot open a file with a filename greater than 12 characters. For best results, enter a name that fits the 8.3 format. That is, the file name should be eight characters or less, followed by a period and an extension of three characters or less (for example, "largest1.txt").
GFK-1260H
2-19
The minimum value and time for each line in the file. The maximum value and time for each line in the file. The value and time each time the line's value changes over the time period.
If you selected more than one line to save, the value and time information for each line is stored independently, as in the following example:
"Soap","Soap_TIME","Wax","Wax_TIME" 1,"03-01-1996 19:29:34.000",1,"03-01-1996 19:29:34.000" 575,"03-01-1996 19:34:34.000",575,"03-01-1996 19:34:34.000" 183,"03-01-1996 19:29:01.840",476,"03-01-1996 19:25:19.270" 179,"03-01-1996 19:29:02.850",472,"03-01-1996 19:25:20.280" 175,"03-01-1996 19:29:03.850",468,"03-01-1996 19:25:21.580" 172,"03-01-1996 19:29:04.860",467,"03-01-1996 19:25:22.590" 169,"03-01-1996 19:29:14.890",466,"03-01-1996 19:25:32.980" 165,"03-01-1996 19:29:15.900",462,"03-01-1996 19:25:34.000" If the reference file is for an array point, the second line contains the first array element, the third line contains the last array elements, and the rest of the rows contain the rest of the array elements. All array elements have the same time value. For example: "Step", "Step_TIME" 100, "03-01-1996 18:19:34.000" 105, "03-01-1996 18:19:34.000" 101, "03-01-1996 18:19:34.000" 102, "03-01-1996 18:19:34.000" 103, "03-01-1996 18:19:34.000" 104, "03-01-1996 18:19:34.000"
2-20
GFK-1260H
3.
Select the line: A. Style. B. Width if the line style is solid. If it is not solid, the width is fixed.
4.
Select how the points should be connected. The choices are Step Smooth (Recommended for runtime display) Connects data points with a stepped line Connects data points with a straight line. The legend will always display the last actual value to the left of the cursor. That is, the value in the legend does not reflect the line interpolation.
5.
(Optional) Check the Hidden check box if you do not want the line to be displayed on the chart at run-time.
GFK-1260H
2-21
2.
1 Select a compression type. 2 Server side compression is only available for lines with historical data.
2-22
GFK-1260H
Option 2. Compression for Lines that have Historical Data If you select compression for a logged line type you have the option to reduce overhead by collecting only the representative data from the Database Logger. This is done because the Database Logger, instead of Trending, determines the value from your criteria and sends only the representative values to Trending. Option 2. Select compression for lines that have historical data: 1. (If the Line Display dialog box is not open) Open the Line Display dialog box. A. Select a line in the Lines grid. B. Click Display. The Line Display dialog box opens. 2. Select a compression type in the Compression field. The Use Server side compression check box is enabled (unless you select None.). How the Database Logger and Trending handle your compression choice depends on your specifications for Server side compression. 3. Do one of the following to specify Server side compression: Leave User Server side compression unchecked. Trending compression behaves the same for the logged line type as it does for lines that are not the logged type. See page 2-22 for details. Enable Server side compression.
Line Display Dialog Box: Server Side Compression Selected
1 Choose a compression type. 2 Check Use Server side compression. 3 Select a time for the sampling resolution.
A. Check User Server side compression. The Sampling Resolution fields are enabled. You can specify the length of the time interval the Database Logger should use to collect data from which it calculates a representative value, with its accompanying timestamp.
GFK-1260H
2-23
B. Enter the number and time the Database Logger should use, e.g. 10 minutes. Result: Database Logger sends values and related timestamps for Trending to display based on your compression type selection and the amount of time you specify that the Database Logger should use for each data group. Compression Type None Average Plotted Value and Timestamp Multiple data points along a vertical line. Average of the values within the specified sampling time. Trending displays the timestamp for the first logged value in the group. First First logged value in the group. Trending displays the timestamp for when that value was logged. Last Last logged value in the group. Trending displays the timestamp for when that value was logged. Minimum Minimum logged value in the group. Trending displays the timestamp for the minimum value in the group. If there is more than one minimum value in the group, Trending displays the timestamp for when the first minimum value was logged. Example Database Logger logged a value of 5,000 three times during the specified time frame. 5,000 is the minimum value in the sample. Trending displays the timestamp for the first 5,000 that the Database Logger logged. Maximum Maximum logged value in the group. Trending displays the timestamp for the maximum value in the group. If there is more than one maximum value in the group, Trending displays the timestamp for the when the first maximum value was logged. Example Database Logger logged a value of 30,000 three times during the specified time frame. 30,000 is the maximum value in the sample. Trending displays the timestamp for the first 30,000 that the Database Logger logged.
2-24
GFK-1260H
Note: The time interval begin time is based on the X-axis pre-set start date and time. Example Your X-axis start time is set to begin at 10:15AM (5-25-02) You have specified 5 minutes as the length of each interval. The first interval: Start time=10:15AM (5-25-02) The second interval: Start time = 10:20AM (5-25-02) See page 2-27 for details about setting the X-axis start time and date.
Go to "Continue (following Method 1 or 2)". Method 2 Popup menus 1. 2. Place the cursor over either the Y-axis or X-axis. Click the right mouse button. A popup menu displays.
Example: X-axis Popup
3.
GFK-1260H
2-25
The Line-Axis Mapping dialog box appears when you use either method.
Example: Line-Axis Mapping Lines associated with the selected axis display in the Lines box. X-axis for selected line
Continue (following Method 1 or 2) Do any or all of the following: 1. 2. Select an axis in the Show lines for axis field to see what lines it represents. Select a line in the Lines field. A. Select an X-axis in the Configured X-axis field to associate with the line. B. Select a Y-axis in the Configured Y-axis field to associate with the line.
Note: Y Chart Axis and X Chart Axis are the default axes.
2-26
GFK-1260H
Axis Configuration
Your trend chart has to have at least on X-axis and one Y-axis. At times, you may want to configure more that can be used instead of either default axis. To begin axis configuration: 1. 2. Open the CIMPLICITY TREND Chart Properties dialog box. Select the Axis tab.
Axis Grid
Color palette
GFK-1260H
2-27
Method 2Popup Menu 1. 2. 3. Position the cursor over the X-axis on the Trend chart. Click the right mouse button. A popup menu appears. Select Time.
X-axis Popup
2-28
GFK-1260H
Go to "Continue (following Method 1 or 2)". Continue (following Method 1 or Method 2) 1. Enter the Duration of time the X-axis represents. The format is ddd:hh:mm:ss where: Letters ddd hh mm ss 2.
Example: X Axis Timing Options (Before Apply is Clicked)
Represent day number: 0365 Hours: 059 minutes: 059 seconds: 059
Clear to allow runtime scroll
ddd= 0 -365 hh = 0 - 23 mm = 0 - 59 ss = 0 - 59
mm/dd/yy
hh:mm:ss
hh:mm:ss
ddd
A. Show most recent No other entry is required. This is the same as selecting Now minus 0 days and Now minus time with a time that is equal to the duration. Enter an Absolute date in mm/dd/yy format Number that specifies the number of days before the current date. For example, enter 5 to begin the display five (5) days before the current date. Absolute time in hh:mm:ss format Number that specifies the number or hours, minutes and seconds before the current time. The number is specified in hh:mm:ss format. For example, enter 1:30:05 for a starting time1 hour 30 minutes and 5 seconds earlier than when the trend is first displayed.
requires:
3.
Click Apply .
GFK-1260H
2-29
Important: Trending compensates for abbreviated entries, e.g., The date 11/05/00 becomes 11/05/2000; a duration entry of 5 becomes 00:00:05.
Example: X Axis Timing Options (After Apply is Clicked) ddd:hh:mm:ss Clear to allow runtime scroll
ddd= 0 -365 hh = 0 - 23 mm = 0 - 59 ss = 0 - 59
mm/dd/yyyy
hh:mm:ss
hh:mm:ss
ddd
Note: If you configure rapid trend retrieval (data compression), Trending uses the start time based on these specifications as the trend interval start time. If you specify a relative time, the start time is based on the time you start the Trend chart. See page 2-23 for details about rapid trend retrieval.
2-30
GFK-1260H
Color palette
2.
Change the font to your specification. The font you choose will be used for all X and Y-axes. 3. Specify the axis characteristics in the Configured axis grid. A. Select a color. Click the Color Palette button , on the lines row in the Color column. The Color Palette opens. Double click a unique line color. B. (Optional) Check Visible to make the X-axis visible. 4. (Optional) Configure a label and ticks for the axis: A. Enter a label in the Label field. The label you enter will be the axis title. B. Select the number of ticks in the Ticks box that you want the X-axis to display. You can select through 100. C. Check the Numbered checkbox to label the tick marks. D. Check the No scroll check box if you do not want users to scroll the X-axis at run-time.
GFK-1260H
2-31
Order of priority when all options are selected. Point Limits are used. If there are no Point Limits, Y-axis changes each time a value goes above or below default limits. 3 Y-axis changes each time a value goes above or below the existing limit. 1 2
Go to "Continue (following Method 1 or 2)". Method 2Popup Menu Configuration 1. 2. Position the cursor over the Y-axis area. Click the right mouse button. A popup menu appears.
Y-axis Popup
2-32
GFK-1260H
3.
Select Limits. A Y-Axis Limits dialog box appears. Go to "Continue (following Method 1 or 2)".
Example. Y-axis Configuration from Popup Menu
Continue (following Method 1 or 2) 1. Enter one, two or all options for the Y-axis limits A. Enter numeric values in the Default lower limit and Default upper limit fields. B. Check the Use Point Limits check box to have Trending use the points limits specified in the ConfigurationPoint dialog box. If Trending cant find limits in the ConfigurationPoint dialog box, it will use the values you enter in the Default lower limit and Default upper limit fields. C. Check the Autoscale check box to have Trending automatically change the Y-axis limits each time a value goes above or below the existing limit. Autoscale functions as follows: 1. 2. The highest and lowest values are found from all lines associated with the axis. The decimal base is calculated for both highest and lowest values. Examples The decimal base of 150 is 100. The decimal base of 7654 is 1000. 3. The high limit is the number closest to the highest number on the high side, using the calculated decimal base from the highest value as multiple.
GFK-1260H
2-33
The low limit is the number closest to the highest number on the low side, using the calculated decimal base from the lowest value as a multiple. Example Given 478 and 7891 as the lowest and highest values found, the calculated low and high limit for the axis is 400 and 8000. This is because 400 is the closest value to 478 on the low side that uses a multiple of 100 and because 8000 is the closest value to 7891 on the high side that uses a multiple of 1000. Guidelines for the order of priority if you select all the limit options Trending: 1. 2. 3. Increments the upper or lower limit each time a value goes above or below the existing limit. Uses the limits specified in the Points Configuration dialog box. Uses the limits specified in the Default lower limit and Default upper limit fields.
2-34
GFK-1260H
Color palette
2.
Change the font to your specification. The font you choose will be used for all X and Y-axes. 3. Specify axis characteristics in the Configured axis grid. A. Select a color. i. ii. Click the Color Palette button , on the lines row in the Color column. The Color Palette opens. Double click a unique line color.
GFK-1260H
2-35
4.
(Optional) Configure a label and ticks for the axis: A. Select the number of ticks in the Ticks box that you want the Y-axis to display. You can select through 100. B. Check the Numbered checkbox to label the tick marks.
5.
Continue to add axes as follows: A. Click the New button axis. to enter completely new information for another
B. Click the Copy button to copy the selected axis. You can then modify the entry. This is particularly useful if you want to follow variations in an expression. C. Click the Delete button to delete any axis beyond the primary X-axis and Y-axis that you decide you dont want.
2-36
GFK-1260H
Chart Properties
There are several details about the chart itself. Details range from the chart's color to how many pixels away a cursor can be from the slider and still grab it. These details are configured on the: Chart tab of the CIMPLICITY Trend Control Properties dialog box and Advanced tab that is accessed through the Chart tab.
Interval for: Chart update Project used for unqualified points, can be changed at runtime. Display scroll buttons If checked, lines: 1. Draw left to right 2. Update across the chart area. 3. Scroll when the right edge is reached 4. Continue update from left to right. Advanced dialog box Chart redrawn (hh:mm:ss)
If checked, lines: 1. Update at the right edge 2. Scroll each time an update is received
3.
Selects color for the: Slider, legend and chart X and Y-axes Default Color: CimEdit ambient Fore color.
GFK-1260H
2-37
Area surrounding the trend chart Default Color: CimEdit ambient Back color. Solid color for the trend chart area Default Color: CimEdit ambient Back color. See the "Configuring a CimEdit Screen" chapter in the CIMPLICITY CimEdit Operation Manual, GFK-1396 for details about ambient colors.
4.
Enter the time between one new data update and the next in the Auto Update Interval field. The format is hh:mm:ss. Example 10 equals ten seconds; 1:00 equals one minute.
Note: Auto update will only occur for lines that have Auto Update selected on the Line tab of the CIMPLICITY Trend Control Properties dialog box. 5. 6. Enter the time between one time that the chart redraws itself and the next in the Auto Refresh Interval field. The format is hh:mm:ss. Select the CIMPLICITY project to be used for any unqualified Point IDs in the Base project field. The default is provided by CimView, but it may be changed at run-time. Trending goes step-by-step, in the following order of priority, to find the project that contains the unqualified points. The step that proves positive is the one Trending uses to determine the project name. Each step applies to both Server and Viewer, unless otherwise noted: Priority Project is used to fully qualify any Unqualified Point IDs when A. In CimView, an Open screen or Overlay screen action specifies a project. When a user opens the screen that contains the Trend chart using one of these actions, the project specified in the action is used. A command line is used to open the CimView screen that contains the Trend chart and the /project option is used, that project is used. The screen that contains the Trend chart is in a project directory, that project is used. The project name in the Trend chart property page is not blank, that project is used. You are on a Server and a single project is currently running, that project is used. You are on a Server and multiple projects are running, the project that was started first is used. However, you can modify this behavior using the PROJECT_ID global parameter. You are on a Viewer, and none of the above conditions are positive, unqualified Point IDs are unavailable.
B. C. D. E. F.
G. 7.
2-38
GFK-1260H
8.
Choose an update style Jump Scroll The line: Starts at the left of the chart Updates across the chart area. Is automatically scrolled by the scroll percentage, specified in the Advanced dialog box, when the right edge is reached Continues to update from left to right. Strip Chart The line: Updates at the right edge of the chart Scrolls each time an update is received
9.
1 Amount of data scroll when scroll buttons are pressed 2 Number of pixels from slider in which the slider can still be grabbed (110). 3 All lines use a single time period and duration 4 Chart Y-Axis. 5 All lines use a single time period and duration. 6 Enables logged data wait state events. 7 Time after which request for logged data is outstanding. 8 Interval to check for outstanding logged requests. 9 Legend shows visible and hidden lines. 10 Jump to current time at next runtime or auto update. 11 Scroll point and logged point lines.
1 2 3 4 5 6 7 8 9 10 11
GFK-1260H
2-39
3.
Determine what Y-axis to display in the Y-axis display field. Choices are: Multiple (Default) Single Percent Configured Display all the currently configured Yaxes that are not hidden Display the chart Y-axis only Display a single Y-axis going from 0 to 100 percent. All the lines are displayed on a scale of 0 to 100 percent of their ranges as configured on the Axis property page.
4.
Enter a percent in the Scroll percentage field to define the: Time duration that the chart data will Scroll backward or forward when the or button is pressed during runtime. Length of the jump when the drawing reaches the right edge of the chart if you set the Update style to Jump scroll in the basic Chart tab. Example of button scroll A chart displays a 2-hour time duration Enter 25 in this field. The chart will scroll backward or forward by a half-hour (25% of two (2) hours) when the scroll button is pressed.
5. 6.
Enter the number (010) of pixels from the slider that a mouse cursor can move and still grab the slider, in the Slider grab margin field.. (Optional) Check the Single X-axis check box if you want the chart to be displayed with a single X-axis called the Chart X Axis. All lines will use the Chart X Axis. In the case of Line charts that represent time, this option is mutually exclusive with the Single Time Duration option. Therefore, if you select this option, the Single time duration check box is unavailable.
7.
(Optional) Check the Single Y-axis check box if you want the chart to be displayed with a single Y-axis called the Chart Y-axis. All lines will use the Chart Y-axis. If you select this option, the Y-axis display is disabled. Check the Single time duration check box if you want all the lines in the chart to use a single time duration. The time duration is the Chart X Axis duration. For example, you want to view the data for all lines for a span of two hours, regardless of start time. For Line charts that represent time, this option is mutually exclusive with the Single X-axis option.
8.
9.
Check the Legend show all check box to display the legend information for all visible and hidden lines on the chart. Clear this check box to display information for only the visible lines on the chart. Use the Legend tab to define the legend elements.
2-40
GFK-1260H
10. Check the Jump to current value check box to make the trend display automatically jump back to the current time at the next run-time or auto update timer interval whenever you scroll the chart. Clear this check box to scroll manually to return to the current time. If one of the objects on the CimView screen has a JumpToCurrentTime method configured for the chart, you can use that method to scroll forward to the current time. This option in combination with Allow Runtime Scrolling affects logged expression behavior. See "Logged Expression Lines and Scrolling Configuration" on page 2-14 in this manual for more information about how logged expressions behave. 11. Check the Allow Runtime Scrolling check box to scroll Expression and Logged Expression lines in the chart at run-time. Clear the Allow Runtime Scrolling checkbox to prevent Expression and Logged Expression lines from scrolling. This option in combination with JumpToCurrentTime affects logged expression behavior. See "Logged Expression Lines and Scrolling Configuration" on page 2-14 in this manual for more information about how logged expressions behave. 12. Check Enable logged data request outstanding state events to enable a wait state event. A. Outstanding state longer than N secondsis the wait time, in seconds, at which a request for logged data is considered outstanding. B. Refresh state every N secondsis the interval, in seconds, at which the Trend control checks if it has any logged requests that have been outstanding for more than the Threshold. See "Wait State Methods and Events" in the Configuring Trend Methods chapter in this manual for details about wait state methods.
GFK-1260H
2-41
Legend Properties
The Legend properties define the legend information for the lines on the chart. To define the legend properties: Method 1Properties dialog box 1. 2. Open the CIMPLICITY Trend Chart Properties dialog box. Select the Legend tab.
Check to Display Legend title.
3.
(Optional) Check the Show legend check box to display the legend on the chart. If you clear the check box, you have completed configuration of this tab. Check the Show title check box to display a title line for the legend. Check the items that will display for each line on the chart in the Line items box. Use the displayed. buttons to create the order in which you want the items
4. 5. 6. 7. 8.
Select one and two columns in the Display format field for legend data display. Enter the number of legend lines to display in the Display height field If you have more lines than can be displayed in the legend area, you can use the vertical scroll bar to the right of the legend area to display the additional information.
9.
Check the information in the Status line box to display on the status line.
2-42
GFK-1260H
10. Click Font to select the font, font style, size and script for the legend and status bar. Method 2Popup Menu in the Legend area 1. 2. Place the cursor over the legend area. Click the right mouse button. A popup menu appears.
Example: Legend Popup
3. 4. 5. 6. 7. 8. 1. 2.
Check Legend to display the legend. Select Show Fields. An extended menu appears. Check any fields you want to display in the Legend. Select Add Lines. An extended menu appears. Select the lines you want to display n the Legend. Check Status to display the status bar. Place the cursor over the Status area. Click the right mouse button. A popup menu appears.
Example: Status Popup
3. 4. 5. 6.
Check Status to display the status line. Select Show Fields. An extended menu appears. Check the fields you want to display in the Status line. Check Legend to display the legend.
GFK-1260H
2-43
Grid Properties
You do this on the Grid tab of the CIMPLICITY Trent Control Properties dialog box. To display gridlines on a chart: Method 1: CIMPLICITY Trend Chart Properties dialog box 1. 2. Open the CIMPLICITY Trend Chart Properties dialog box. Select the Grid tab.
Choose a solid line. Specify the width
3. 4.
(Optional) Check the Show grid check box to display a grid on the chart. If you clear the check box, you have completed configuration of this tab. Configure the gridline by selecting the: A. Color B. Style C. Width, if the line style is solid. If it is not solid, the width is fixed.
5.
Enter the number of gridlines to display. Choose one of two alternatives: Fixed Axis ticks from line Enter the number of horizontal and vertical gridlines to display Select an axis whose ticks will determine the grid lines. If you select Use nearest axis, the first axis with tick marks is used to determine the grid lines.
2-44
GFK-1260H
Method 2Popup menu in chart area (CimEdit or CimView) 1. 2. 3. 4. Place the cursor anywhere in the chart area. Click the right mouse button. Select Show/Hide. An extended menu displays. Select Grid.
Chart Popup: Grid Selected
GFK-1260H
2-45
Runtime Actions
Whether or not an operator can access one or more of the tabs or even open the CIMPLICITY Trend Control Properties dialog box during runtime is under your control. To enable/disable tabs in the CIMPLICITY Trend Control Properties dialog box for runtime: 1. 2. Open the CIMPLICITY TREND Chart Properties dialog box. Select the Runtime Actions tab.
Example: Enabling Tabs in Properties Dialog Box for Runtime
3.
Check the Show property pages at runtime check box to let an operator open the CIMPLICITY Trend Control Properties dialog box during runtime. If you clear the check box, you have completed configuration of this tab. Check the tabs that an operator can change during runtime in the Pages enabled at runtime box.
4.
Important: It you are using a reference file, you need to enable at least the Runtime Actions tab so the operator can export data to the reference file. It is on this tab that the export button, which is disabled during configuration, is enabled during runtime.
2-46
GFK-1260H
For example, to look at the first element in ARRAY, enter ARRAY[0]. To trend an entire array at a single instant in time: Enter the array name only. The resulting display depends on the Line Type you have chosen. Logged data Reference file Expression The whole array is drawn as it was at the axis end time. The time of the array is provided in the file. The most recent data for the array is displayed.
Whenever the array data changes, the old line is erased and a new one, representing the new data, is drawn. Arrays display, as follows: 1. 2. 3. Full arrays are shown with the first array element drawn at the left edge of the chart. The elements of the array are equally spaced across the length of the chart. The space between the last element and the end of the chart is equal to the space between the first two elements.
GFK-1260H
2-47
Click the drop-down list button to the right of the Color field.
Double click a blank box to create a custom color Right click an existing customized color to edit it.
2.
2-48
GFK-1260H
Color picker
Luminosity picker
Actual color selected (example is dithered). Closest solid color available Double click Solid to choose it. Change a single color's index value, to change its luminance in the mix. The picker positions and color box reflect the change. Hue=red, green and blue proportions based on their entered values. Saturation=Defines color vividnes (amount of gray). Luminance=Amount of light in the color (0=Black).
3.
Do one or more of the following until you have created the color you want. You can see the exact color and the solid color that is closest to it in the Color|Solid box. A. Move the Color picker around to change the color. B. Enter exact Index values for any or all of the colors in the color fields. 0 for all colors = Black. 0 for one color = Black for that value 255 for all colors = White 255 for one color = Pure red, green or blue for that value The color that displays reflects the combination of the three entries C. Move the Luminosity picker up and down to change the amount of light (absence of black) in the color.
GFK-1260H
2-49
D. Enter an exact value that specifies the amount of light in the color in the Lum field. 0 = Black (The colors values will change to 0) 240 = White (The colors values will change to 255. Any changes you make in this value will affect all the colors. E. Specify how vivid the color specified by the balance of the three basic colors should be in the Sat field. 0 = Gray 240 = No gray. F. Specify the balance of red, green and blue that you want in the Hue field. This balance is calculated against the values that are already in the Color fields.
4.
Decide whether to use the exact color or the solid color displayed in the Color|Solid box. possibilities are: A. The exact color is the same as the solid color. B. The exact color is dithered, a pattern of dots that simulates the color. Only the solid portion of a dithered color will display in a pattern. C. The solid color that is closest to exact color.
5.
Select the option you want. A. Double click the Solid side of the Color|Solid box to add the solid color. The box changes to the solid color. B. Click Add Color when in the Color|Solid box if: Both the exact and solid display. The exact color will be selected. Only the solid color displays. The solid color will be selected.
Modifying a Color
You can modify any color on the palette. If you choose a standard color to modify, the customized color appears in the customized section of the palette. To modify a color: 1. 2. 3. 4. 5. Click the Palette button to the right of the Color field. Select a color in the customized color section. Click the right mouse button. The Color (custom color) Palette opens. Proceed as you would if you were creating a new color. When you have edited the color, the new color appears in the custom color box that the edited color used to occupy.
2-50
GFK-1260H
Choosing a Font
Whenever you have to specify a font and its characteristics in Trending, you can do so in a basic Windows 98/NT Font dialog box. To specify a font for a Trending text item: 1. Choose one of the following: Click the Font button Click Font on the Axis tab or on the Legend tab.
2.
Select the font. If you use TrueType fonts, users can resize a screen in CimView and still have the text be displayed in proportion to the rest of the objects on the screen. Select the font style and size.
3.
GFK-1260H
2-51
GFK-1260H
3-1
Invoke method Method On the CimView Trend Chart, to: Line AddDynPointLine AddExpressionLine AddLoggedLine AddLoggedExpressionLine DeleteTrendLine SetLineAutoupdate SetLineCompression SetLineDisplay SetLineVisible WriteReferenceFile Legend SetLegendState Axis (X or Y) SetAxisTicks X-axis (Time Related) JumpToCurrentTime PauseUpdates ScrollLines SetXDuration SetXStartTime Make the legend visible/invisible Display ticks and tick labels on either an X or Yaxis. Set the chart time to the current time. Pause or resume updates Scroll the chart by the given percentage Change the X-axis duration. Change the Chart X-axis for one or all lines.
Add a specified point line Add a specified expression line Add a specified logged line Add a specified logged expression line Delete a specified line Change the auto-update status of one or all nonruntime lines Set the compression specifications for a particular Line ID. Set the color, compression and expansion of a given line. Toggle the line visibility in both the chart and legend for one or all lines.
8 10 11 13 15 16 18 20 24 26 28 30
31 33 34 35 37
3-2
GFK-1260H
Invoke method Method Y-axis SetAxisLabel SetLineYAxis SetYAxisVisible SetLineUseChartY Visual Aids ResetZoom SetGridState
Display a label for a selected Y-axis. Change the Y-axis settings. Change the visibility of one or all Y axes Toggle the use of the Chart Y-axis for a line. Reset zoom in the Trend Control to 100%. Change the grid visibility for the Trend Control.
39 40 42 44 46 47
DisableOutstandingLoggedRequestState
Enables the firing of logged data wait state events in the Trend control. Disables or turns off the firing of logged data request wait state events in the Trend control.
49
50
Display the Help About dialog box for the CIMPLICITY Trend Control. Redraws the chart to display the current values. Set the CIMPLICITY project for the Trend Control.
61 61 62
In addition to methods, Trending offers you a list of events you can select in CimView as events of type ActiveX Event. An event is a way for the Trend object to notify CimView that something has occurred. You can use one or all of the following events to perform an action in CimView when they occur: Event EnteringOutstandingLoggedRequestState On the CimView Trend Chart, when: Trend control has determined that it has logged data requests that have been outstanding (waiting) for longer than the number of seconds determined by the threshold. Trend control has determined that it no longer has any logged data requests that are outstanding.
51
LeavingOutstandingLoggedRequestState
52
GFK-1260H
3-3
Method Configuration
To configure a method: Name a Trend Control. Create an Invoke Method action. Methods cover the: Line display Legend X-axis (time related) Y-axis Visual aids Wait state and events Other features
3-4
GFK-1260H
A B C D
9.
Click Advanced if the button is enabled. This means the function returns a value that contains output arguments. The Edit Method dialog box opens.
10. Click OK when you have completed configuration to save the event.
GFK-1260H
3-5
2.
Enter an expression in the Value column that will pass as the argument for each argument in the Name column. Your options are: A. You must make an entry for each parameter that has a No in the Optional box. If the argument is optional, you will see Yes in the Optional box. Choose one of the following to pass argument values to a method: Type Integer String Enter An expression or Point ID that evaluates to a numeric value. Choose one or a combination of the following: 1. 2. 3. Point ID that refers to a text point Constant string enclosed in double quotes
If/Then/Else condition where: If is A (from either 1 or 2 on the list) Then is B (a text expression) Else is C (a text expression)
A short hand If/Then/Else is A?B:C B. If the argument can be used as an output argument, the Do Setpoint checkbox will be enabled. To assign the output value of the argument to a CIMPLICITY Point when the function exits, enter the Point ID in the expression field. Currently the Do Setpoint checkbox is not enabled for any Trending methods.
3-6
GFK-1260H
3.
(Optional if enabled) Enter a setpoint in the Method result field if the function returns a value. You can use a device or global Point ID with the correct Point Type for the status value. Click OK to save your changes and return to the Actions tab. Click OK to save the procedure information and return to the Events tab. Click OK to save the event.
4. 5. 6.
Note: Some argument types are not supported (for example, IDispatch*, and IUnknown*). These will appear as <Bad type> in the Type column and the Expression field will be disabled. If the unsupported argument is required, you will not be able to configure this method for invocation. If you plan to pass a parameter via the contents of a CIMPLICITY Point ID, the contents of the Point ID will be converted to match that of the parameter. The valid ranges for each type used by Trend methods are: Type BOOL BSTR double Valid Range Boolean with a value or 0 or 1. Any string. Numbers will be converted to strings. Floating point number in the range (2.2250738585072014e-308 to 1.7976931348623158e+308) Long integer in the range -2147483648 to 2147483647 Short integer in the range -32768 to 32767
long short
GFK-1260H
3-7
AddLoggedexpressionLine Add a specified logged expression line AddExpressionLine DeleteTrendLine SetLineAutoupdate SetLineCompression SetLineDisplay SetLineVisible WriteReferenceFile
AddDynPointLine Method
Purpose: To easily add a point's available logged and ongoing current data to the runtime Trend Control without having to specify the data source. The addition occurs when the method is triggered by an event or through a script. Lines using automatically found logged and runtime data display a combination of runtime and logged data. Runtime data is reported by CIMPLICITY Point Management. Logged data comes from a CIMPLICITY Log table, which CIMPLICITY finds when the method is triggered. The order in which CIMPLICITY looks for logged data is as follows: 1. 2. 3. 4. A CIMPLICITY data table. The first data table in alphabetical order. A CIMPLICITY group table. The first group table in alphabetical order.
If the point is not being logged to either a data or group table, the trend line displays as current data becomes available. The behavior of the logged point line type depends on the Allow Runtime Scrolling property
3-8
GFK-1260H
To configure the AddDynPointLine method. 1. Select AddDynPointLine Method for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying AddDynPointLine.
(Optional) A setpoint that contains the status valuedevice or global Point ID Boolean point
3.
Enter the following: A. A string that provides a name for the Line ID. The name will appear in the Legend to identify the added line. B. A Point ID string that Trending will evaluate to find the ODBC data source in which CIMPLICITY will find the table and Point ID data for the line display. See above for the order in which CIMPLICITY looks for data.
4.
(Optional) Enter a Method result. Use a Point ID in the Boolean Point Class with a Data Structure Type of BOOL. You can use a device or global Point ID. Result: When you invoke the method, the optional Method result contains one of the following values. Value 1 0 Method Result The line was successfully added to the trend. The line was not added to the trend.
GFK-1260H
3-9
AddExpressionLine Method
Purpose: To add a specified expression line to the runtime Trend Control when Invoke Method is triggered by an event. Lines using runtime data display data reported by the CIMPLICITY Point Manger. The line cannot be scrolled as all information comes from current data. This type of line is also called a current trend. To configure the AddExpressionLine method: 1. Select AddExpressionLine in the Method field for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying AddExpressionLine.
(Optional) A setpoint that contains the status valuedevice or global Point ID Boolean point
3. Enter the following: A. A string that provides a name for LineID. The name will appear in the legend to identify the added line. B. A string that evaluates to an expression, which is one or more Point IDs and mathematical operators that can be evaluated. Trending creates the trend based on the identified values.
3-10
GFK-1260H
4.
(Optional) Enter a Method result. Use a Point ID in the Boolean Point Class with a Data Structure Type of BOOL. You can use a device or global Point ID. Result: When you invoke the method, the optional Method result contains one of the following values. Value 1 0 Method Result The line was successfully added to the trend. The line was not added to the trend.
AddLoggedLine Method
Purpose: To add a specified logged line to the runtime Trend Control when Invoke Method is triggered by an event. Lines using Logged data display data from a CIMPLICITY Database Logger group or data table. This type of trend is also called a historical trend because all the information comes from logged data. To configure the AddLoggedLine method: 1. Select AddLoggedLine Method for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. he Edit Method dialog box opens displaying AddLoggedLine.
(Optional) A setpoint that contains the status valuedevice or global Point IDBoolean point
1 2
GFK-1260H
3-11
3.
Enter the following: A. A string that provides a name for the Line ID. The name will appear in the Legend to identify the added line. B. Strings that Trending will evaluate to find the: ODBC data source in which CIMPLICITY will find the table and column for the line display. If you require a User ID and password enter them on this line. Including "DSN=" is optional. In either case, the UID= and PWD= must appear after the DSN. Example Either of the following is correct:
CIMPLICITY Point Logging;UID=Administrator;PWD=98403 "DSN=CIMPLICITY Point Logging;UID=Administrator;PWD=98403
Table in the Database Logger where the line data will be found. Column in the Database Logger table that contains the lines data. 4. (Optional) Enter a Method result. Use a Point ID in the Boolean Point Class with a Data Structure Type of BOOL. You can use a device or global Point ID. Result: When you invoke the method, the optional Method result contains one of the following values. Value 1 0 Method Result The line was successfully added to the trend. The line was not added to the trend.
Note: The source for a Logged line is data from any point logging table. For more information about point logging tables, see Using the Database Logger in the CIMPLICITY HMI Base System User's Manual (GFK-1180).
3-12
GFK-1260H
AddLoggedExpressionLine Method
Purpose: To add a specified logged expression line to the runtime Trend Control when Invoke Method is triggered by an event. Lines using logged and runtime data display a combination of runtime and logged data. Runtime data is reported by CIMPLICITY Point Management. Logged data comes from a CIMPLICITY Log table. The behavior of the logged point line type depends on the Allow Runtime Scrolling property To configure the AddLoggedExpressionLine method: 1. Select AddLoggedExpressionLine in the Method field for the Invoke method Action type.
2.
Click an enabled Advanced Properties dialog box. The Edit Method dialog box opens displaying AddLoggedExpressionLine.
(Optional) A setpoint that contains the status valuedevice or global Point IDBoolean point
1 2 3
1 2 3
GFK-1260H
3-13
3. Enter the following: A. A string that provides a name for the Line ID. The name will appear in the legend to identify the added line. B. A string that evaluates to an expression, one or more Point IDs and mathematical operators that can be evaluated. Trending creates the trend based on the specified expressions values. C. Strings that Trending will evaluate to find the: ODBC data source in which CIMPLICITY will find the table and column for the line display. If you require a User ID and password enter them on this line. Including "DSN=" is optional. In either case, the UID= and PWD= must appear after the DSN. Example Either of the following is correct:
CIMPLICITY Point Logging;UID=Administrator;PWD=98403 "DSN=CIMPLICITY Point Logging;UID=Administrator;PWD=98403
Table in the Database Logger where the line data will be found. Column in the Database Logger table that contains the lines data. 4. (Optional) Enter a Method result. Use a Point ID in the Boolean Point Class with a Data Structure Type of BOOL. You can use a device or global Point ID. Result: When you invoke the method, the optional Method result contains one of the following values. Value 1 0 Method Result The line was successfully added to the trend. The line was not added to the trend.
Note: The source for a Logged line can be a point from any point logging table. For more information about point logging tables, see "Using the Database Logger" in the "CIMPLICITY HMI for Base System User's Manual" (GFK-1180).
3-14
GFK-1260H
DeleteTrendLine Method
Purpose: To delete a specified point line from the runtime Trend Control when Invoke Method is triggered by an event. To configure the DeleteTrendLine method: 1. Select DeleteTrendLine in the Method field for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying DeleteTrendLine.
(Optional) A setpoint that contains the status valuedevice or global Point IDAnalog point
3. 4.
Enter a string that evaluates to an existing Line ID. Trending will delete the specified line when the method is invoked. (Optional) Enter a Method result. Use a Point ID in the Analog Point Class. You can use a device or global Point ID. Result: When you invoke the method, the Method result displays one of the following: The number of lines deleted from the chart A dialog box with an appropriate error message, if an existing line cannot be deleted Zero, if the line does not exist on the chart
GFK-1260H
3-15
SetLineAutoupdate
Purpose: To change the autoupdate status of one or all non-point lines on the Trend Control.Method
Important: This method has no effect on Point or Logged Point lines. To configure the SetLineAutoupdate method: 1. Select the SetLineAutoupdate in the Method field for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying SetLineAutoupdate.
(Optional) A setpoint containing the status valuedevice or global Analog point
3.
Enter the following: A. One of the following to identify what line or lines should be automatically updated. Value String for a Line ID Identifies All non-point lines on the chart The line to autoupdate
3-16
GFK-1260H
B. An expression or Point ID for nOffOnToggle that evaluates to the numeric value: Value 0 1 2 4. Trending will: Turn off selected line(s) autoupdate Make selected line(s) start autoupdating Toggle the current state of the line(s)
(Optional) Enter a Method result. Use a Point ID in the Analog Point Class. You can use a device or global Point ID. When you invoke the method, the Method result display contains the count of the number of lines that were changed.
GFK-1260H
3-17
SetLineCompression Method
Purpose: To set the compression specifications for a particular Line ID. To configure the SetLineCompression method: 1. Select SetLineCompression in the Method field for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying SetLineCompression.
(Optional) A setpoint containing the status valuedevice or global Boolean point
1 2 3 4 1 Identifies line, in legend. 0None 1Average 4 0Seconds 2First point 1Minutes 3Last point 2Hours 4Minimum point 5Maximum point 6Average of historical group 7First point-historical group 8Last point-historical group 9Smallest value-historical group 10Largest value-historical group 3 Units for each historical group 2
3-18
GFK-1260H
3. Enter the following: A. A string that identifies the Line ID whose display parameters you want to change. B. An expression or Point ID for NoneAvgFirstLastMinMax that evaluates to one of the following numeric values: Value 0 1 2 3 4 5 Trending will: Not do any compression Plot the average of the values in the group Plot the first data point in the group Plot the last data point in the group Plot the data point from the group with the smallest value Plot the data point from the group with the largest value If you are using compression, Trending automatically determines the group size. 6 7 8 9 10 Plot the average of the values in the group, using server side compression. Plot the first data point in the group, using server side compression. Plot the last data point in the group, using server side compression. Plot the data point from the group with the smallest value, using server side compression. Plot the data point from the group with the largest value, using server side compression.
C. Enter the number of time units that should be used for each group of data. D. Enter the unit of time to be used as follows: Enter 0 1 2 For Seconds Minutes Hours
GFK-1260H
3-19
SetLineDisplay Method
Purpose: To set the color, compression and expansion, and display method for a particular Line ID. To configure the SetLineDisplay method: 1. Select SetLineDisplay in the Method field for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying SetLineDisplay.
(Optional) A setpoint containing the status valuedevice or global Boolean point
1 2 3 4 Identifies line, in legend. 2 RGB Color Values 1 3 0None 4 0Step mode 1Average 1Smooth mode 2First point 3Last point 4Minimum point 5Maximum point 6Average of historical group 7First point-historical group 8Last point-historical group 9Smallest value-historical group 10Largest value-historical group
3. Enter the following: A. A string that identifies the Line ID whose display parameters you want to change. B. An RGBColor value from either the Standard RGBColor Values Table or calculate your own. See page 3-21 for more information. C. An expression or Point ID for NoneAvgFirstLastMinMax that evaluates to one of the following numeric values:
3-20
GFK-1260H
Value 0 1 2 3 4 5
Trending will: Not do any compression Plot the average of the values in the group Plot the first data point in the group Plot the last data point in the group Plot the data point from the group with the smallest value Plot the data point from the group with the largest value If you are using compression, Trending automatically determines the group size.
6 7 8 9 10
Plot the average of the values in the group, using server side compression. Plot the first data point in the group, using server side compression. Plot the last data point in the group, using server side compression. Plot the data point from the group with the smallest value, using server side compression. Plot the data point from the group with the largest value, using server side compression.
Note: If you enter an option from 6 through 10, this field performs the same as the Type field in SetLineCompression.Specify the time interval to collect the historical group size either in a SetLineCompression method or in the Trend control's Line Display dialog box. See the "Configuring the Trend Control" chapter for details about the Line Display dialog box. D. An expression or Point ID for StepSmooth that evaluates to one of the following numeric values: Value 0 1 4. Trending will: Display the line in step mode Display the line in smooth mode
(Optional) Enter a Method result. Use a Point ID in the Boolean Point Class with a Data Structure Type of BOOL. You can use a device or global Point ID. Result: When you invoke the method, the optional Method result contains one of the following values: Value 1 0 Method Result The change was successfully made. The change was not made.
GFK-1260H
3-21
Each RGB color is: Made up of a balance of red, green and blue luminosity values ranging from 0 to 255. Example If you apply a luminosity value of: 0 to each of the basic RGB colors (red, green and blue), the color that you see will be Black. 255 to each of the basic RGB colors, the displayed color that you see will be White. Color Single Value Red Green Blue Displayed Color 0 Black Black Black Black 255 Red Green Blue White Has a calculated value with the following formula: RGBColor Value =
255 (To represent Red; The selected number can be 0-255) + (256 * a Green luminosity number) + (65536 * a Blue luminosity number) +
Example RGBColor = 255 + (256*105) + (65536*255) = 16738815 (the RGBColor value) You can use the Custom Colors palette in CimEdit to determine the Red, Green, and Blue values for the color you want to use.
Example: Customized Color Palette Providing Luminosity for RGB Calculation
3-22
GFK-1260H
GFK-1260H
3-23
SetLineVisible Method
Purpose: To change one or all lines on the Trend Control visible or invisible. To configure the SetLineVisible method: 1. Select SetLineVisible Method for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying SetLineVisible.
(Optional) A setpoint containing the status valuedevice or global Boolean point
3. Enter the following: A. One of the following for LineID to identify the line or lines you want to become invisible or visible: Value Identifies All the lines
An existing Line ID A single line B. An expression for nOffOnToggle that evaluates to one of the following numeric values. Value 0 1 2 Trending will: Make selected line(s) invisible Make selected line(s) visible Toggle
3-24
GFK-1260H
4.
Optional) Enter a Method result. Use a Point ID in the Boolean Point Class with a Data Structure Type of BOOL. You can use a device or global Point ID. When you invoke the method, the optional Method result contains one of the following values: Value 1 0 Method Result The line is visible. The line is invisible.
Note: When the line is made invisible, it is removed from the chart. If you did not check the Always visible legend option, the line description is also removed from the legend. Even thought the line is removed from the display, the Trend Control still collects data and performs calculations for the line.
GFK-1260H
3-25
WriteReferenceFile Method
Purpose: To write data for all lines on the chart to the reference file you designate.
Important: This method is available only on Intel Windows 95 and Intel Windows NT platforms. To configure the WriteReferenceFile method: 1. Select WriteReferenceFile Method for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying WriteReferenceFile.
(Optional) A setpoint containing the status valuedevice or globalAnalog point
1 2 3
1 2 3 Value entry is required. 1 Lines included in file 2 Evaluate to 0 3 File location details
3. Enter the following: A. A null terminated string to identify what Lines values Trending should include in the Reference file when the method is invoked. Value Identifies All the lines on the chart Specific lines to export B. The number of lines specified in A.
3-26
GFK-1260H
C. Identify the file and location: The Path where the reference file will be located. It is recommended that you put the reference file in its own directory. A name for the reference File (8 character limit). 4. (Optional) Enter a Method result. Use a Point ID in the Analog Point Class. You can use a device or global Point ID. When you invoke the method, the Method result displays 0.
GFK-1260H
3-27
Legend Methods
You can give a Trend user the ability to make the Legend visible or invisible with the SetLegendState method.
SetLegendState Method
Purpose: To change the visibility of the legend for the trend. To configure the SetLegendState method: 1. Select SetLegendState Method for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying SetLegendState.
(Optional) A setpoint containing the status valuedevice or global Boolean point
3.
Enter an expression or Point ID for nOffOnToggle that evaluates to one of the following numeric values. Value 0 1 2 Trending will: Hide the legend Show the legend Toggle the visibility of the legend
3-28
GFK-1260H
4.
(Optional) Enter a Method result. Use a Point ID in the Boolean Point Class. You can use a device or global Point ID. When you invoke the method, the Method result displays: Value 1 0 Method Result Legend is visible Legend is invisible
GFK-1260H
3-29
Axis Methods
Trending provides you with: A SetAxisTicks method to display ticks and tick labels on either an X or Yaxis when a specified event occurs, Several X-axis (time related) methods and Several Y-axis methods.
SetAxisTicks Method
Purpose: To display ticks or ticks and tick labels on either an X or Y-axis. To configure the SetAxisTicks method: 1. Select SetAxisTicks Method for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying SetAxisTicks.
(Optional) A setpoint that contains the status valuedevice or global Point ID Boolean point
1 2 3 1 Axis on which the label displays. 2 Number of ticks to display. 3 0Ticks only 1Ticks and tick labels
3. Enter the following: A. The name of the axis for AxisID to identify to what axis Trending should display a label. B. The number of ticks to display along the axis. C. A Boolean for bLabelTicks that specifies: Value 0 1 Trending will display: Ticks only Ticks and tick labels
3-30
GFK-1260H
JumpToCurrentTime Method
Purpose: To move the axis of a specified line, and associated lines, so that the current time is within the visible time span on the trend. This lets you see the latest incoming values if the line has run-time information. To configure the JumpToCurrentTime method: 1. Select the JumpToCurrentTime Method for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying JumpToCurrentTime.
(Optional) A setpoint that contains the status valuedevice or global Point ID Analog point
GFK-1260H
3-31
3.
Enter one of the following for LineID to name what lines should jump to the current time. Entry Existing Line ID Identifies All X-axes with runtime and/or auto updating lines The X-axis associated with the line
4.
(Optional) Enter a Method result. Use a Point ID in the Analog Point Class with a Data Structure Type of BOOL. You can use a device or global Point ID. When you invoke the method, the Method result contains the number of lines that jumped to the current time.
3-32
GFK-1260H
PauseUpdates Method
Purpose: To pause or resume updates in the trend. To configure the PauseUpdates method: 1. Select PauseUpdates Method for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying PauseUpdates.
(Optional) A setpoint that contains the status valuedevice or global Point ID Boolean point
0 resume trending 1 pause the trend 2 toggle the current pause state
3.
Enter a Point ID or expression for nNoYesTog that evaluates to one of the following numeric values: Value 0 1 2 Trending will: Resume the trend. Pause the trend. Toggle the current pause state of the trend.
4.
(Optional) Enter a Method result. Use a Point ID in the Boolean Point Class with a Data Structure Type of BOOL. You can use a device or global Point ID. When you invoke the method, the Method result contains 0. While the trend is paused, "PAUSED" displays in the upper left corner of the chart.
GFK-1260H
3-33
ScrollLines Method
Purpose: To scroll all lines that can be scrolled on the chart by the indicated percentage. To configure the ScrollLines method: 1. Select ScrollLines Method for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying ScrollLines.
(Optional) A setpoint that contains the status valuedevice or global Point ID Boolean point
3. Enter the following: A. An expression or Point ID for NLeftRight that evaluates to one of the following numeric values: Value 0 1 Trending will: Scroll left Scroll right
B. An expression or Point ID for nPercent that evaluates to a percentage value between 0 and 100. 4. (Optional) Enter a Method result. Use a Point ID in the Boolean Point Class with a Data Structure Type of BOOL. You can use a device or global Point ID. When you invoke the method, the optional Method result contains one of the following values: Value 1 0 Method Result Parameters are good and scroll performed. Parameters are bad.
3-34
GFK-1260H
SetXDuration Method
Purpose: To change the X-axis duration settings for a single line or all lines on the chart that use the chart X-axis and scrolls lines to beginning of chart. To configure the SetXDuration method: 1. Select SetXDuration Method for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying SetXDuration.
(Optional) A setpoint that contains the status valuedevice or global Point ID Boolean point
1 2
1 2 1 Identifies line for x-axis duration change. Value entry is required. 2 (Seconds x Time) and additional milleseconds.
GFK-1260H
3-35
3. Enter the following: A. Enter one of the following for Line ID to name what lines should have the duration of the X-axis changed: Entry An existing Line ID B. Enter the duration of the X-axis for: i. ii. 4. Seconds. Multiply minutes by 60; hours by 3600 Milliseconds in addition to seconds, for the X duration. (Optional) Enter a Method result. Use a Point ID in the Boolean Point Class with a Data Structure Type of BOOL. You can use a device or global Point ID. When you invoke the method, the optional Method result contains one of the following values. Value 1 0 Method Result The X-axis duration was successfully changed. The X-axis duration was not changed. Identifies The Chart X Axis The axis that belongs to the line
3-36
GFK-1260H
SetXStartTime Method
Purpose: To specify a start time of the X-axis for the chart or indicated line and redraw the trend. To configure the SetXStartTime method: 1. Select SetXStartTime Method for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying SetXStartTime.
(Optional) A setpoint that contains the status valuedevice or global Point ID Boolean point Setpoint not allowed
1 2 3 1 Identifies line for x-axis duration change 2 mm/dd/yy hh:mm:ss AM/PM 3 To the millesecond
3. Enter the following: A. Enter one of the following for Line ID to name what lines should have the duration of the Y-axis changed: Entry An existing Line ID Identifies The Chart X Axis The axis that belongs to the line
GFK-1260H
3-37
B. The following format for the DateTime string. "<day> <month> <year> <hh>:<mm>[:<ss>] <pp>" For <day> <month> <year> <hh> <mm> <ss> <pp> Example
"02 Feb 1997 07:00 AM" "15 Mar 1997 3:45:15 PM"
Enter the: Number of the day of the month Three-character abbreviation for the month Two digits for the year Hour of the 12-hour clock Two digits for the minutes (Optional) Two digits for the seconds Either AM or PM.
C. Enter a number from 0 through 999 for nMilliseconds. 4. (Optional) Enter a Method result. Use a Point ID in the Boolean Point Class with a Data Structure Type of BOOL. You can use a device or global Point ID. Result: When you invoke the method, the optional Method result contains one of the following values: Value 1 0 Method Result The X-axis start time was successfully changed. The X-axis start time was not changed.
3-38
GFK-1260H
Y-axis Methods
Trending provides you with the following methods to let a Trend user change the y-axis during runtime: Invoke method Method SetLineYAxis SetYAxisVisible SetLineUseChartY On the CimView Trend Chart, to: Change the Y-axis settings. Change the visibility of one or all Y axes Toggle the use of the Chart Y-axis for a line.
SetAxisLabel Method
Purpose: To display a label that describes the Y-axis. To configure the SetAxisLabel method: 1. Select SetAxisLabel Method for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying SetAxisLabel.
(Optional) A setpoint that contains the status valuedevice or global Point ID Boolean point
3. Enter the following: A. The name of the axis for AxisID to identify to what axis Trending should display a label. B. The text that will display as the label, when the event occurs.
GFK-1260H
3-39
SetLineYAxis Method
Purpose: To change the Y-axis settings for a single line or all lines that use the chart Y-axis. To configure the SetLineYAxis method: 1. Select SetLineYAxis Method for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying SetLineYAxis.
(Optional) A setpoint that contains the status valuedevice or global Point ID Boolean point
1 2 3 4 1 Identifies line for y-axis change 2 Y-axis Lower,Upper Limits 3 0Invisible 1Visible 4 0Disable autoscaling 1Enable autoscaling
3-40
GFK-1260H
3. Enter the following: A. One of the following for LineID to identify for what lines Trending should change the Y-axis parameters Value An existing Line ID Identifies The Chart Y Axis The axis that belongs to the line
B. A minimum Y-axis value for Lower and maximum value for Upper. C. An expression or Point ID for Visible that evaluates to one of the following numeric values. Value 0 1 Trending will: Make the Y-axis invisible Make the Y-axis visible
D. An expression or Point ID for Autoscale that evaluates to one of the following numeric values. Value 0 1 4. Trending will: Not Autoscale Perform Autoscaling
(Optional) Enter a Method result. Use a Point ID in the Boolean Point Class with a Data Structure Type of BOOL. You can use a device or global Point ID. Result: When you invoke the method, the optional Method result contains one of the following values: Value 1 0 Method Result The Y-axis has been set. The Y-axis was not set.
GFK-1260H
3-41
SetYAxisVisible Method
Purpose: To change the visibility of one or all Y-axes on the Trend Control. To configure the SetYAxisVisible method: 1. Select SetYAxisVisible Method for the Invoke method Action type.
2.
3-42
GFK-1260H
3. Enter the following: A. One of the following for LineID to identify for what lines Trending should make the y-axis invisible or visible. Value Identifies The Chart Y Axis
An existing Line ID The axis that belongs to the line B. An expression or Point ID for nOffOnToggle that evaluates to one of the following numeric values. Value 0 1 2 4. Trending will: Make the selected axis invisible Make the selected axis visible Toggle the current state of the axis
(Optional) Enter a Method result. Use a Point ID in the Boolean Point Class with a Data Structure Type of BOOL. You can use a device or global Point ID. Result: When you invoke the method, the optional Method result contains one of the following values: Value 1 0 Method Result The Y-axis has been made visible. The Y-axis has been made invisible.
Note: Make sure your trend has Y-axis display type of Multiple if you want more than one Y-axis visible at the same time.
GFK-1260H
3-43
SetLineUseChartY Method
Purpose: To change the line's Y-axis to either the Chart Y Axis or an axis whose ID is the line's ID plus a _Y suffix. To configure the SetLineUseChartY method: 1. Select SetLineUseChartY Method for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying SetLineUseChart.
(Optional) A setpoint that contains the status valuedevice or global Point IDBoolean point
1 2 1 Identifies line whose Chart y-axis visibility is used/not used 2 0Chart-Y axis not used 1Chart-Y axis used
3.
Enter the following: A. A string that evaluates to an existing Line ID. B. Enter an expression or Point ID for UseChartYAxis that evaluates to one of the following numeric values: Value 0 1 Trending will: Not use the Chart Y-axis Use the Chart Y-axis
3-44
GFK-1260H
4.
(Optional) Enter a Method result. Use a Point ID in the Boolean Point Class with a Data Structure Type of BOOL. You can use a device or global Point ID. When you invoke the method, the optional Method result contains one of the following values: Option 1If the line was using the Chart Y Axis and UseChartYAxis is 0, when the method is invoked, Trending disables and Chart Y-axis and maintains the current settings. Option 2If the line was not using the Chart Y Axis and UseChartYAxis is 1, then when the method is invoked the Chart Y Axis is enabled and the current chart axis settings are used. Value 1 0 Method Result The method executed successfully. The method failed.
GFK-1260H
3-45
ResetZoom Method
Purpose: To reset the zoom on a trend to 100%. To configure the ResetZoom method: Select ResetZoom Method for the Invoke method Action type.
3-46
GFK-1260H
SetGridState Method
Purpose: To change the grid visibility for the Trend Control. To configure the SetGridState method: 1. Select SetGridState Method for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying SetGridState.
(Optional) A setpoint containing the status valuedevice or global Boolean point
3.
Enter an expression or Point ID that evaluates to one of the following numeric values: Value 0 1 2 Trending will: Hide the grid Show the grid Toggle the current state of the grid
4.
(Optional) Enter a Method result. Use a Point ID in the Boolean Point Class with a Data Structure Type of BOOL. You can use a device or global Point ID. Result: When you invoke the method, the optional Method result contains one of the following values: Value 1 0 Method Result Grid is visible Grid is not visible
GFK-1260H
3-47
3-48
GFK-1260H
EnableOutstandingLoggedRequestStateEvent Method
Purpose: To enable the firing of logged data wait state events in the Trend control. To configure the EnableOutstandingLoggedRequestStateEvent method: 1. Select EnableOutstandingLoggedRequestStateEvent Method for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying EnableOustandingLoggedRequestStateEvent.
1 2 1 Seconds Trend checks logged requests outstanding for longer than the threshold 2 Seconds that request is outstanding
3.
Enter the following: A. An expression or Point ID for the RefreshRate that evaluates to a numeric value. This value is the interval, in seconds, at which the Trend control checks if it has any logged requests that have been outstanding for more than the Threshold. B. An expression or Point ID for the Threshold that evaluates to a numeric value. This value is the wait time, in seconds, at which a request is considered outstanding.
GFK-1260H
3-49
DisableOutstandingLoggedRequestStateEvent Method
Purpose: To disable the firing of logged data wait state events in the Trend control. To configure the DisableOutstandingLoggedRequestStateEvent method: Select DisableOutstandingLoggedRequestStateEvent Method for the Invoke method Action type.
3-50
GFK-1260H
EnteringOutstandingLoggedRequestState Event
Purpose: Fired when the Trend control has determined that it has logged data requests that have been outstanding (waiting) for longer than the number of seconds determined by the threshold. To configure the EnteringOutstandingLoggedRequestState event: 1. Create an ActiveX Event and select the EnteringOutstandingLoggedRequestState Event.
EnteringOutstandingLoggedRequestState
2.
Create an Action for the event. This action can be either a script or a procedure in CimView.
GFK-1260H
3-51
LeavingOutstandingLoggedRequestState Event
Purpose: Fired when the Trend control has determined that it no longer has any logged data requests that are outstanding. To configure the LeavingOutstandingLoggedRequestState event: 1. Create an ActiveX Event and select the LeavingOutstandingLoggedRequestState Event.
LeavingOutstandingLoggedRequestState
2.
Create an Action for the event. This action can be either a script or a procedure in CimView.
3-52
GFK-1260H
Note: This example uses the following Expression lines, which are already configured for the chart. Line 1 Line 2 Line 3 S90_350 S90_500 S90_900
Configuration steps include: Step 1. Step 2. Step 3. Step 4. Step 5. Step 6. Create a screen level variable. Activate Trending's wait state feature. Configure an EnteringOutstandingLoggedRequestState event. Configure a LeavingOutstandingLoggedRequestState event. Configure an object to report Trending's request status. Test the request configuration at runtime.
4.
Click OK.
Result: CimEdit creates a screen level variable that can be used by the Trend control and any other configured objects on the screen.
GFK-1260H
3-53
4. 5.
Result: The CIMPLICITY Trend Control Properties dialog box closes with the Enable logged data request outstanding state events feature enabled.
3-54
GFK-1260H
4.
Configure the event's procedure. A. Click the Menu button to the right of the Action field.
B. Select New Procedure from the popup menu. The Procedure Information dialog box opens.
GFK-1260H
3-55
C. Configure the procedure as follows: i. ii. Enter Busy_1 in the Procedure name field. Select Variable assign in the Action type field.
iii. Click the Browse button to the right of the Variable ID field. iv. Select BUSY from the popup menu. v. Enter 1 in the Variable value field.
1 Select Variable assign 2 Select BUSY (created at the screen level). 3 Enter 1. (Initial screen level value = 0).
1 2 3
G. Click OK. Result: The Events tab displays the configured EnteringOutstandingLoggedRequestState event.
3-56
GFK-1260H
iii. Click the Browse button to the right of the Variable ID field. iv. Select BUSY from the popup menu. v. Enter 0 in the Variable value field. vi. Click OK. Result: The Events tab displays the configured LeavingOutstandingLoggedRequestState event in the Events list.
GFK-1260H
3-57
2.
Open the green light's Properties - Object dialog box. A. Right click the light. The Properties - Group dialog box opens. B. Select the Group tab. C. Expand the Round_Light tree. D. Expand the Group41 tree. E. Select Shape5. E. Click OK. The Properties - Object dialog box opens.
3. 4.
Select the Color Animation tab. Click Edit . The Expression List Attribute Animation dialog box opens.
3-58
GFK-1260H
5.
Configure the animation. A. Enter {BUSY} EQ 1 in the Expression field. B. C. D. E. Check Fill. Select Solid, Red. Check Blink. Click Close .
BUSY value=0 at screen level. EnteringOutstandingLoggedRequestState event value=1.
The Color Animation tab displays an expression count of 1. 6. Click OK. Result: The Properties - Group dialog box closes and the light is configured to blink red when Trending enters an outstanding wait state at runtime.
GFK-1260H
3-59
Result: CimView appears. When there are: No Outstanding state (requests) longer than N seconds as specified on the Advanced tab of the CIMPLICITY Trend Control Properties dialog box, the light appears green. Outstanding state (requests) longer than N seconds as specified on the Advanced tab of the CIMPLICITY Trend Control Properties dialog box, the light blinks red. See Step 2 page 54 for details.
3-60
GFK-1260H
AboutBox Method
Purpose: To display the Help About dialog box for the CIMPLICITY Trend control. To configure the AboutBox method: Select AboutBox Method for the Invoke method Action type.
ForceRedraw Method
Purpose: To redraw the Trend chart to display the current values. To configure the ForceRedraw method: Select ForceRedraw Method for the Invoke method Action type.
GFK-1260H
3-61
SetCimplicityProject Method
Purpose: To set the CIMPLICITY project that will be used by the Trend Control when it displays data. To configure the SetCimplicityProject method: 1. Select SetCimplicityProject Method for the Invoke method Action type.
2.
Click an enabled Advanced button in the Edit tab of the Properties dialog box. The Edit Method dialog box opens displaying SetCimplicityProject.
Project name
3.
Enter a string that names the project CIMPLICITY should use for the Trend Control.
Note: When you invoke this method, the selected project will be used for all point lines where the Point ID is not fully qualified.
3-62
GFK-1260H
GFK-1260H
4-1
4-2
GFK-1260H
Changes include: Chart color Line: M Color M Style M Width Axes font size Background color Legend: M Font M Display Status display
Note: The most recent four trends that are saved, appear on the File drop down menu.
GFK-1260H
4-3
4-4
GFK-1260H
Introducing XY Plots
About XY Plots
XY Plots provide you with the ability to visually represent values in relation to each other. For example, you can plot real data vs. calculated date, or elements such pressure vs. temperature. XY Plots provides you with: An extensive XY Plot object model with which you can script XY Plots that are as easy or as complex as you need. A CIMPLICITY XY Control Properties dialog box to make detailed chart design selections. A SmartObject XY Control with which you can quickly create an effective XY Plot. You have considerable control over what an XY Plot displays and its appearance using any of the tools that XY Plot provides. You can create an XY Plot that displays: One or several XY series One or more X,Y axes Minimum detail so a user can view quickly view the pattern of relative values All the details a user needs to fully analyze any of the XY series Allow a runtime user, for the one runtime session, specify what should display. For display, you can choose the colors, line types and fonts that you think will work best.
GFK-1260H
5-1
Slider
Display Series Specify font and style legend and specific details Display sparse detail Optional
5-2
GFK-1260H
You configure this powerful feature in CimEdit and display it in CimView. The XY Plot is an ActiveX control that you can configure as follows. 1. 2. 3. Insert the control into a CimEdit screen. XY provides an XY toolbar button that you simply click. Configure the chart's design. A CIMPLICITY Plot Control dialog box provides a long list of design choices. Specify runtime data criteria. XY comes with XY properties and methods that you can use in scripts to manipulate runtime. You can also design the chart by using scripts in addition to, or instead of, the CIMPLICITY Plot Control dialog box. If you want to begin with a chart that is pre-configured, you can take advantage of the XY Plot SmartObject. See the "Using XY Plot SmartObjects" chapter in this manual for details.
GFK-1260H
Introducing XY Plots
5-3
Designing an XY Plot
GFK-1260F-1
6-1
Place the ActiveX Placement cursor where you want the top left corner of the control to be located. You can move the control any time you want.
3. 4. 5.
Click the left mouse button. The Insert Object dialog box opens. Select the ActiveX tab. Select CIMPLICITY XY Plot control.
6.
Click OK. A new XY Plot control is placed at the position you selected in your CimEdit screen.
6-2
GFK-1260F-1
Increase width
Method 2Precision 1. 2. Select Edit on the menu bar. Select Properties. Go to "Continue" (after choosing from Methods 2-4) Method 3-Precision Click the Properties button on the Format toolbar.
GFK-1260F-1
Designing an XY Plot
6-3
Method 4Precision 1. 2. Hold down the right mouse button. Select Properties from the drop-down menu. Go to "Continue" (after choosing from Methods 2-4) The Properties Object dialog box displays when you use Methods 2-4. Continue (after choosing from Methods 2-4) 1. 2. Select the Geometry tab. Enter the width and / or height for the XY Plot in the Width field and Height field.
Method 2
6-4
GFK-1260F-1
The XY Plot Properties dialog box opens when you use any method.
GFK-1260F-1
Designing an XY Plot
6-5
Double click a blank box to create a custom color Right click an existing customized color to edit it.
2.
6-6
GFK-1260F-1
Color picker
Luminosity picker
Actual color selected (example is dithered). Closest solid color available Double click Solid to choose it. Solid double clicked
Change a single color's index value, to change its luminance in the mix. The picker positions and color box reflect the change. Hue=red, green and blue proportions based on their entered values. Saturation=Defines color vividnes (amount of gray). Luminance=Amount of light in the color (0=Black).
3.
Do one or more of the following until you have created the color you want. You can see the exact color and the solid color that is closest to it in the Color|Solid box. A. Move the Color picker around to change the color. B. Enter exact Index values for any or all of the colors in the color fields. 0 for all colors = Black. 0 for one color = Black for that value 255 for all colors = White 255 for one color = Pure red, green or blue for that value The color that displays reflects the combination of the three entries C. Move the Luminosity picker up and down to change the amount of light (absence of black) in the color. D. Enter an exact value that specifies the amount of light in the color in the Lum field. 0 = Black (The colors values will change to 0) 240 = White (The colors values will change to 255. Any changes you make in this value will affect all the colors. E. Specify how vivid the color specified by the balance of the three basic colors should be in the Sat field. 0 = Gray 240 = No gray. F. Specify the balance of red, green and blue that you want in the Hue field. This balance is calculated against the values that are already in the Color fields.
GFK-1260F-1
Designing an XY Plot
6-7
4.
Decide whether to use the exact color or the solid color displayed in the Color|Solid box. possibilities are: A. The exact color is the same as the solid color. B. The exact color is dithered, a pattern of dots that simulates the color. Only the solid portion of a dithered color will display in a pattern. C. The solid color that is closest to exact color.
5.
Select the option you want. A. Double click the Solid side of the Color|Solid box to add the solid color. The box changes to the solid color. B. Click Add Color when in the Color|Solid box if: Both the exact and solid colors display. The exact color will be selected. Only the solid color displays. The solid color will be selected.
Modifying a Color
You can modify any color on the palette. If you choose a standard color to modify, the customized color appears in the customized section of the palette. To modify a color: 1. 2. 3. 4. 5. Click the down arrow to the right of the Color input field. Select a color in the customized color section. Click the right mouse button. The Color (custom color) palette opens. Proceed as you would if you were creating a new color. When you have edited the color, the new color appears in the custom color box that the edited color used to occupy.
6-8
GFK-1260F-1
Choosing a Font
Whenever you have to specify a font and its characteristics in XY, you can do so in a basic Windows 98/NT Font dialog box. To specify a font for an XY Plot text item: 1. Click the Font button on any Font line.
2.
Select the Font. If you use True Type fonts, users can resize a screen in CimView and still have the text display in proportion to the rest of the objects on the screen. Select the font's: Style Size Script
3.
4.
Check the Strikeout and/or Underline check boxes to display the font with those effects.
Note: The font color is the foreground color. The color in the Font dialog box, therefore does not apply to the XY Plot fonts.
GFK-1260F-1
Designing an XY Plot
6-9
Background
Foreground Chart
To specify an XY Plot control background, chart and foreground colors: 1. 2. Open the CIMPLICITY XY Plot control Properties dialog box. Click the down arrow BackgroundColor ChartColor ForegroundColor The CIMPLICITY HMI palette opens. 3. Select the color you want. The XY Plot control provides properties that enable you to use CimEdit ambient colors as the XY Plot background, chart and foreground colors. The default, for these properties, is TRUE. When you specify a color XY automatically changes using the ambient to FALSE. on any or all of the following rows.
6-10
GFK-1260F-1
Automatically changes to False when a color other than the ambient is specified. Resetting to True restores the ambient.
To use the CimEdit ambient colors for the XY Plot background, chart and foreground colors: 1. 2. Open the CIMPLICITY XY Plot Control Properties dialog box. Specify the value as TRUE for any of the following properties. (The default is TRUE.) UseAmbientBackgroundColor UseAmbientChartColor UseAmbientForegroundColor
GFK-1260F-1
Designing an XY Plot
6-11
6-12
GFK-1260F-1
Step 1. Expand the tree under X or Y: 1. Do one of the following to expand the tree under X or Y: Method 1 Click the Method 2 A. Click the right mouse button. B. Select Expand on the popup menu to the left of either the X or Y.
. Method 3 Double click X or Y. When you use any method, the tree expands to display: Count (Read only) Item 2. The number of X or Y-axes that have been configured for the chart. The properties appear in a tree under Item.
Use any of the methods you used for X or Y to expand Item. (Choose Expand from the popup menu list, if you choose that method.)
Note: Follow any of the three methods when the tree is expanded to collapse the tree. Select Collapse from the popup menu.
Step 2. Expand a selected X or Y-axis: 1. 2. Select a number, e.g. 0, under the X or Y-axis Item. Use any of the three methods described in Step 1 to expand the axis tree and to to their left. (Choose Expand from expand properties in the tree that have a the popup menu list, if you choose that method.)
GFK-1260F-1
Designing an XY Plot
6-13
Step 3. Choose the location of and data flow direction along an X or Y-axis: 1. Select Orientation under XItem or YItem to specify the location of the axis on an XY Plot. Orientation apOrientationBottom apOrientationLeft apOrientationRight apOrientationTop 2. Orients the axis on a chart toward the: Lower part. (X-axis only) Left side. (Y-axis only) Right side. (Y-axis only) Upper side. (X-axis only)
Select the Direction in which data will flow. Direction apDirectionForward apDirectionBackward Specifies the flow or direction to be: Standard (Upward for a Y-axis, rightward for an X-axis) Alternate (Downward for a Y-axis, leftward for an X-axis)
Step 4. Define the data format type for an X or Y-axis: 1. 2. Expand Format. Choose the Type of format in which the data will be reported. Type apNumberInteger apNumberFixed apNumberScientific Does the following: Displays a number as an integer. If the actual number is fractional, it will be rounded. Displays a fixed real number with a specified number of decimal places. Displays a number in scientific notation with a specified number of decimal places. The default is 6 if precision is not specified. Defines an automatic way to use either apNumberFixed or apNumberScientific formats based on the size of the value. Precision information indicates the exponent to start displaying in scientific format. Interprets a number as the number of seconds since 00:00 GMT on January 1, 1970.
apNumberCompact
apNumberAbsoluteTime
apNumberAbsoluteTimeEx Interprets a date and time from the value of the 8-byte floating-point number. Days are represented by whole number increments starting with 30 December 1899 GMT. Hour values are expressed as the absolute value of the fractional part of the number starting at midnight with a value of 0. This is equivalent to the Date type in CimView scripting or Visual Basic. apNumberRelativeTime apNumberCustom Interprets a number as an elapsed time value in seconds. Uses a format string in the standard C language format notation to display a number.
6-14
GFK-1260F-1
3.
Make additional entries, when they apply, to define more precisely the selected Type. A. For apNumberAbsoluteTime, select the item, Absolute Time. Specify the time format string Choose your specific entries from the following list. The letters must be in uppercase or lowercase as shown (for example, ss, not SS). Characters in the format string that are enclosed in single quotation marks will appear in the same location and unchanged in the output string. Entry d dd ddd dddd M MM MMM MMMM y yy yyyy h hh H HH m mm s ss t tt Displays Day of month as digits with no leading zero for single-digit days. Day of month as digits with leading zero for single-digit days. Day of week as a three-letter abbreviation. Day of week as its full name. Month as digits with no leading zero for single-digit months. Month as digits with leading zero for singledigit months. Month as a three-letter abbreviation. Month as its full name. Year as last two digits, but with no leading zero for years less than 10. Year as last two digits, but with leading zero for years less than 10. Year represented by full four digits. Hours with no leading zero for single-digit hours (12-hour clock). Hours with leading zero for single-digit hours (12-hour clock). Hours with no leading zero for single-digit hours (24-hour clock). Hours with leading zero for single-digit hours (24-hour clock). Minutes with no leading zero for single-digit minutes. Minutes with leading zero for single-digit minutes. Seconds with no leading zero for single-digit seconds. Seconds with leading zero for single-digit seconds. One character time marker string, such as A or P. Multicharacter time marker string, such as AM or PM.
GFK-1260F-1
Designing an XY Plot
6-15
Example To display 01/01/1999 12:05:00 AM Use the format string: MM/dd/yyyy hh:mm:ss tt. B. For apNumberAbsoluteTimeEx, the format argument consists of one or more of the following codes. The formatting codes are preceded by a percent sign %. Characters that do not begin with % are displayed unchanged. Format Code %a %A %b %B %c %d %H %I %j %m %M %p %S %U %w %W %x %X %y %Y %z, %Z %% Description Abbreviated weekday name Full weekday name Abbreviated month name Full month name Date and time representation appropriate for locale Day of month as decimal number (01 - 31) Hour in 24-hour format (00 - 23) Hour in 12-hour format (01 - 12) Day of year as decimal number (001 - 366) Month as decimal number (01 - 12) Minute as decimal number (00 - 59) Current locales A.M./P.M. indicator for 12hour clock Second as decimal number (00 - 59) Week of year as decimal number, with Sunday as first day of week (00 - 53) Weekday as decimal number (0 - 6; Sunday is 0) Week of year as decimal number, with Monday as first day of week (00 - 53) Date representation for current locale Time representation for current locale Year without century, as decimal number (00 - 99) Year with century, as decimal number Time-zone name or abbreviation; no characters if time zone is unknown Percent sign
6-16
GFK-1260F-1
The # flag may prefix any formatting code. In that case, the meaning of the format code is changed as follows: Format Code Meaning Flag is ignored. (Format code above) %#c Long date and time representation, appropriate for current locale. For example: Tuesday, March 14, 1995, 12:41:29. Long date representation, appropriate to current locale. For example: Tuesday, March 14, 1995. %#a, %#A, %#b, %#B, %#p, %#X, %#z, %#Z, %#% #
%#x
%#d, %#H, %#I, %#j, %#m, %#M, %#S, %#U, %#w, %#W, %#y, #Y Remove leading zeros (if any). (Format code above) C. For apNumberCustom, select the item Custom. Use a format string in the standard C language format notation to display a number. D. For apNumberScientific or apNumbercompact, select Precision if you need to change it from the default of 6. E. For apNumberRelativeTime, select RelativeTime. Choose one entry.: Entry apTimeDDHHMMSS apTimeHHMMSS apTimeHHTenths apTimeMMSS apTimeMMTenths Displays relative time as: Day:hours:minutes:seconds Hours:minutes:seconds. Hours and tenths Minutes:seconds. Minutes and tenths
Step 5. Design the line (pen) for an X or Y-axis: 1. 2. 3. Select Pen under XItem or YItem. Click the to expand the tree. to the right of the displayed color. Select a Color for the axis. A. Click the down arrow 4. Choose the line's Style. Style apPenDash apPenDashDot apPenDashDotDot apPenSolid (Default) 4. Specify the line Width. A value of 1 is equivalent to 1/100th of a millimeter. This equivalence applies in CimView only when the screen is at 100% zoom. The value of this property defaults to 0, which corresponds to a 1-pixel width regardless of the graphical device (e.g display versus a printer). Displays B. Select a color from the palette that appears.
GFK-1260F-1
Designing an XY Plot
6-17
Step 6. Configure the ticks on an X or Y-axis: 1. 2. 3. Select Ticks under the XItem or YItem. Click the TRUE FALSE (Default) 4. 5. to expand the tree. The label count is automatically calculated. The label count is manually specified. Specify if AutoCount should be:
Select Count to specify how many ticks should appear. The default is 2. Configure the Font for the label. A. Select Font in the tree under Ticks. B. Either i. ii. Click the down arrow and configure the font in the Font dialog box that appears. The font you configure will be used. Set UseAmbientFont to TRUE. The ambient font for the CimEdit screen will be used. The default is TRUE.
Step 7. Configure the limits, mode and scroll properties on an X or Y-axis: 1. Select the Mode under X-Item or Y-Item in which the axis limits will perform during runtime. Mode apAxisAutoscaled Defines an axis where the: Low and high limits change to fit all the data values of all the series that use the axis. The increment used on the high limit is based on the decimal base of the largest series data value. The decrement used on the low limit is based on the decimal base of the smallest series data value. If the largest data value increments between 1 and 9, the high limit increments in single digits because the decimal base is 1. When the value reaches 10, the limit increments in double digits, 10, 20 ,30, etc. When the value reaches 100, the limit incrments in triple digits, 100, 200, 300, etc. The same principle works for the low limit. apAxisFixed Low and high limits are fixed. They do not change regardless of the values of all the series that use the axis. This means that only those data values that fall between the fixed limits are displayed. High limit is set to the maximum data value of all the series plus the scroll percent of the original axis width. The low limit is set to the high limit minus the original axis width. The original axis width is the initial high limit minus the initial low limit. This mode is very useful for incremental flow data.
apAxisScrolled
6-18
GFK-1260F-1
3.
Specify the High and Low Limits. During runtime, the limits will display in response to the mode you specified. The defaults are: High Low 100 0
4.
If apAxisScrolled is selected, configure the Backward and Forward scroll buttons. A. Click the to the left of BackwardScroll under XItem or YItem.
B. Specify whether or not to display the Full Backward Scroll button when the X-axis is in the Forward direction. i. ii. Click the to the left of Full. Set Visible to TRUE to display the button, FALSE to hide the button.
C. Specify whether or not to display the Partial Backward Scroll button when the X-axis is in the Forward direction. i. ii. Click the to the left of Partial. Set Visible to TRUE to display the button, FALSE to hide the button.
D. Specify whether or not to display the Full Forward Scroll button, when the X-axis is in the Forward direction. i. ii. Click the to the left of Full. Set Visible to TRUE to display the button, FALSE to hide the button.
E. Specify whether or not to display the Partial Forward Scroll button when the X-axis is in the Forward direction. i. ii. Click the to the left of Partial. Set Visible to TRUE to display the button, False to hide the button.
Step 8. (Optional) Add additional axes: 1. 2. 3. Select Item under X or Y. Click the right mouse button. Select Add from the popup menu.
GFK-1260F-1
Designing an XY Plot
6-19
4.
5.
Click OK. A next number up from the number of existing X or Y-axes appears under Item. Example You had one X-axis. You add a second. The first X-axis appears in the list under Item as 0. The second will be listed as 1.
Automatically displays the total number of X or Y-axes
New X-axis
Original X-axis
6.
Expand the new axis and configure it using the same steps you used for the previous axis.
Important: When you select Add, XY immediately adds an axis. It does not wait for you to click the Apply button. Step 9. Configure properties to prioritize an axis and identify it: 1. Specify the Order of priority in which the axis will be addressed by the XY Plot. The default is the lowest priority. Example The XY Plot has three axes. You add a fourth. The fourth axis' default order will be 3 (0, 1, 2, 3). 2. Enter a Name for the axis.
6-20
GFK-1260F-1
3.
Configure a Title for the axis. A. Configure the Font for the Title. i. ii. Select Font in the tree under Title. Either a. b. and configure the font in the Font Click the Font button dialog box. The font you configure will be used. Set UseAmbientFont to TRUE. The ambient font for the CimEdit screen will be used.
B. Specify the title content. i. ii. Select Value. Enter the text that you want to display. The default is X Axis under the X and Y Axis under the Y.
C. Select TRUE for Visible in the tree under Title to display the title. The default is TRUE. 4. Select TRUE for Visible (in the path under XItem or YItem) to display the axis. The default is TRUE.
Step 10. (Optional) Remove axes: Remove all X or Y-axes 1. 2. 3. Select Item. Click the right mouse button. Select Remove All.
Remove a selected axis 1. 2. 3. Select the axis number that you want to remove. Click the right mouse button. Select Remove.
Caution: When you select Remove All or Remove, XY Plot immediately makes the removal. It does not wait for you to click the Apply button. Therefore, select those two options very carefully. (If you saved the CimEdit screen before you accidentally remove an item, close the CIMPLICITY XY Plot Control Properties dialog box and the CimEdit screen without saving it. The screen will re-open with the last saved features, including the features you removed.)
GFK-1260F-1
Designing an XY Plot
6-21
Designing a Series
Following are some quick steps to customize every property for a series. Step 1. Step 2. Step 3. Step 4. Step 5. Step 6. Step 7. Step 8. Step 9. Step 10. Add additional series. Configure properties that identify the series. (Optional) Remove series. Expand the tree under Series. (You can collapse whatever you expand.) Expand a selected series. Select the type of series. Configure a fill (brush) for a series. Configure the markers. Configure the line (pen). Configure the X and Y-axes for the series.
6-22
GFK-1260F-1
Specify if a series' values should be in the legend. (Optional) Enter X and Y values for the series.
Step 1. Add additional series: 1. 2. 3. Select Item under Series. Click the right mouse button. Select Add from the popup menu.
The Add Methods dialog box opens. 4. 5. Enter a name for the series in the Value column. Select a Series Type. The default is apSeriesStandard.
Enter an series name
6.
Click OK. A next number up from the number of existing series appears under Item. Example You had one Series. You add a second. The first series appears in the list under Item as 0. The second will be listed as 1.
Automatically displays the total number of series
New series
Original series
GFK-1260F-1
Designing an XY Plot
6-23
7.
Expand the new series and configure it using the same steps you used for the previous series.
Step 2. Configure properties that identify the series: 1. 2. 3. Enter a Name for the series. Select True for InLegend to have the series should appear in the legend. The default is True. Select TRUE for Visible (in the tree under the SeriesItem) to display the series. The default is TRUE.
Step 3. (Optional) Remove series: Remove all series 1. 2. 3. Select Item. Click the right mouse button. Select Remove All.
Remove a selected series 1. 2. 3. Select the axis number that you want to remove. Click the right mouse button. Select Remove.
Caution: When you select Remove All or Remove, XY Plot control immediately makes the removal. It does not wait for you to click the Apply button. Therefore, select those two options very carefully. Step 4. Expand the tree under Series: 1. Do one of the following to begin expanding the list under Series: Method 1 Click the Method 2 A. Click the right mouse button. B. Click the Expand popup menu to the left of Series.
6-24
GFK-1260F-1
Method 3 Double click Series. The tree expands to display: Count (Read only) Item 3. The number of series that have been configured for the chart. The properties appear in a tree under Item.
Use any of the methods you used for Series to expand Item. (Choose Expand from the popup menu list, if you choose that method.)
Note: Follow any of the three methods when the tree is expanded to collapse the tree. The popup menu displays as Collapse
. Step 5. Expand a selected Series: 1. 2. Select a number, e.g. 0, under the Series Item. Use any of the three methods described in Step 1 to expand the axis tree and to expand properties in the tree that have a to their left. (Choose Expand from the popup menu list, if you choose that method.)
Step 6. Select the type of series: Choose one of the following Types under SeriesItem. Type apSeriesScatter apSeriesStandard (Default) apSeriesStep Defines A series that has no lines A standard series, which is a line between two data values (connects the dots). An X-based step that flows horizontally, then vertically from one data value to the next.
Step 7. Configure a fill (brush) for a series marker: 1. 2. Select Brush under SeriesItem. Select a color for the marker's fill. A. Click the down arrow 3. Select the brush Type. Type apBrushSolid apBrushHatch Fills the series with a: Solid color Hatch (pattern) to the right of the displayed color. B. Select a color from the palette that appears.
GFK-1260F-1
Designing an XY Plot
6-25
4.
Select a HatchStyle for the brush if you selected apBrushHatch as the type. apHatchBackwardDiagonal apHatchCross apHatchDiagonalCross apHatchForwardDiagonal apHatchHorizontal apHatchVertical
Step 8. Configure the markers for a series: 1. 2. Select Marker under SeriesItem. Select the Type of marker. Type apMarkerCircle apMarkerSquare apMarkerTriangle 3. 4. Displays a: Circle Square Triangle
Select TRUE for Visible (in the tree under Markers) to make the markers for the series visible. Specify the marker's Width. A value of 1 is equivalent to 1/100th of a millimeter. This equivalence applies in CimView only when the screen is at 100% zoom. The value of this property defaults to 250.
Step 9. Configure the line (pen) for a series: 1. 2. Select Pen under SeriesItem. Select a Color for the series line. A. Click the down arrow 3. to the right of the displayed Color. B. Select a color from the palette that appears. Select the series' line (pen) Style. Style apPenDash apPenDashDot apPenDashDotDot apPenSolid (Default) Displays
6-26
GFK-1260F-1
4.
Select line Width for the series line. A value of 1 is equivalent to 1/100th of a millimeter. This equivalence applies in CimView only when the screen is at 100% zoom. The value of this property defaults to 0, which corresponds to a 1-pixel width regardless of the graphical device (e.g display versus a printer).
Step 10. Configure the X and Y-axes for a series: 1. 2. Right click X or Y under SeriesItem if you want an X or Y-axis to associate a specific axis with the series. Select Set from the popup menu.
3.
Select the axis that you want to associate from the list of available axes. See the "XY Series Properties" section in this chapter for procedures to configure an X or Y-axis.
Step 11. Specify if a series' values should appear in the legend: 1. 2. Expand a selected series under SeriesItem. Set InLegend to TRUE to display the series' values in the Series Legend; FALSE to omit the series from the legend. Note: You specify the type of value to display under Legends in the CIMPLICITY XY Plot Control Properties dialog box.
GFK-1260F-1
Designing an XY Plot
6-27
Step 12. (Optional) Enter X and Y values for a series: 1. 2. 3. 4. Expand Data under SeriesItem. Enter, in the Count field, the number of X,Y points (represented by markers) that you want to display. Expand X. Expand Item. The number you entered in the DataCount field, displays in the X-Count field. The list of X numbers (coordinates), for which you can enter values totals the Count value. 5. 6. Enter a value for each X coordinate. Repeat the process for Y. Example
Series (Manual) Data Entry Example
6-28
GFK-1260F-1
Designing a Slider
Following are nine quick steps to customize every property for a slider. Step 1. Step 2. Step 3. Step 4. Step 5. Step 6. Step 7. Step 8. Step 9. Expand the tree under Sliders. (You can collapse whatever you expand.) Expand a selected Slider.. Select the Type of Slider. Configure the line (pen) for a slider. Specify the slider's initial position and its visibility. Specify if a slider's values should be in the legend. (Optional) Add additional sliders. Configure properties to prioritize a slider and identify it. (Optional) Remove sliders.
GFK-1260F-1
Designing an XY Plot
6-29
Step 1. Expand the tree under Sliders: 1. Do one of the following to expand the tree under X or Y: Method 1 Click the Method 2 A. Click the right mouse button. B. Click the Expand popup menu. to the left of Sliders.
Method 3 Double click X or Y. When you use any method, the tree expands to display: Count (Read only) Item 2. The number of sliders that have been configured for the chart. The properties appear in a tree under Item.
Use any of the methods you used for Sliders to expand Item. (Choose Expand from the popup menu list, if you choose that method.)
Step 2. Expand a selected slider: 1. 2. Select a number, e.g. 0, under the Series Item. Use any of the three methods described in Step 1 to expand the axis tree and to expand properties in the tree that have a to their left. (Choose Expand from the popup menu list, if you choose that method.)
Step 3. Select the Type of Slider: Under SliderItem, select either: Type apSliderVertical (Default) Displays the: Interesected Y data value shows. This is because a vertical slider moves across the X-axis. Therefore, for each X data value that the slider is at, you have a Y data value on the series data vector. If there is more than one intersected Y data value, the data value that is displayed is the first intersected data value found from the end to the beginning of the data vector.
6-30
GFK-1260F-1
apSliderHorizontal
Interesected X data value shows. This is because a horizontal slider moves across the Y axis. Therefore, for each Y data value that the slider is at, you have an X data value on the series data vector. If there is more than one intersected X data value, the data value that is displayed is the first intersected data value found from the end to the beginning of the data vector.
Step 4. Configure a slider line (pen) for a slider: 1. 2. Select Pen under SliderItem. Select a Color for the series line. C. Click the down arrow 3. to the right of the displayed Color. D. Select a color from the palette that appears. Select the slider's line (pen) Style. Style apPenDash apPenDashDot apPenDashDotDot apPenSolid (Default) 4. Select line Width for the slider line. A value of 1 is equivalent to 1/100th of a millimeter. This equivalence applies in CimView only when the screen is at 100% zoom. The value of this property defaults to 0, which corresponds to a 1-pixel width regardless of the graphical device (e.g display versus a printer). Step 5. Specify the slider's initial position and its visibility: 1. Specify the slider's Position as a percent (0 to 100). This is the position the slider will be at whenever the XY Plot is opened. The designated percent indicates the position from left to right for a vertical slider; bottom to top, for a horizontal slider. 2. Select TRUE for Visible (in the tree under the SlidersItem) to display the slider. The default is TRUE. Displays
Step 6. Specify if a slider's values should appear in the legend: 1. 2. Expand a selected slider under SliderItem. Leave the InLegend default of TRUE to display the slider's values in the Slider Legend; set it to FALSE to omit the slider from the legend. Note: You specify the type of value to display under Legends in the CIMPLICITY XY Plot Control Properties box.
GFK-1260F-1
Designing an XY Plot
6-31
Step 7. (Optional) Add additional sliders: 1. 2. 3. Select Item under Sliders. Click the right mouse button. Select Add from the popup menu.
The Add Methods dialog box opens. 4. 5. Enter a name for the series in the Value column. Select a Slider Type. The default is apSliderVertical.
6.
Click OK. A next number up from the number of existing series appears under Item. Example You had one slider. You add a second. The first slider appears in the list under Item as 0. The second will be listed as 1.
Automatically displays the total number of slider
New slider
Original slider
7.
Expand the new slider and configure it using the same steps you used for the previous slider.
6-32
GFK-1260F-1
Step 8. Configure properties to prioritize a slider and identify it: 1. Specify the Order of priority in which the slider will be addressed by the XY Plot. The default is the lowest priority. Example The XY Plot has three sliders. You add a fourth. The fourth sliders' default order will be 3 (0, 1, 2, 3). 2. 3. Enter a Name for the slider. Leave Visible as TRUE to display the slider; select FALSE to hide it.
Step 9. (Optional) Remove sliders: Remove all X or Y-axes 1. 2. 3. Select Item. Click the right mouse button. Select Remove All.
Remove a selected slider 1. 2. 3. Select the slider number that you want to remove. Click the right mouse button. Select Remove.
Caution: When you select Remove All or Remove, XY Plot immediately makes the removal. It does not wait for you to click the Apply button. Therefore, select those two options very carefully.
GFK-1260F-1
Designing an XY Plot
6-33
Step 1. Expand the tree under Grid: Do one of the following to expand the tree under Grid: Method 1 Click the Method 2 A. Click the right mouse button. B. Click the Expand popup menu. to the left of Grid.
6-34
GFK-1260F-1
Method 3 Double click Grid. The tree expands to display the grid's property options.
Note: Follow any of the three methods when the tree is expanded to collapse the tree. The popup menu displays as Collapse.
. Step 2. Design the line (pen) for a grid: 1. 2. 3. Select Pen under Grid. Click the to expand the tree. to the right of the displayed color. Select a Color for the axis. A. Click the down arrow 4. Choose the line's Style. Style apPenDash apPenDashDot apPenDashDotDot apPenSolid (Default) 5. Specify the line Width. A value of 1 is equivalent to 1/100th of a millimeter. This equivalence applies in CimView only when the screen is at 100% zoom. The value of this property defaults to 0, which corresponds to a 1-pixel width regardless of the graphical device (e.g display versus a printer). Step 3. Specify the grid density: 1. Specify the number of horizontal gridlines. A. Select HorizontalCount under Grid. B. Enter the number of horizontal lines that will display. 2. Specify the number of vertical gridlines. A. Select VerticalCount under Grid. B. Enter the number of vertical lines that will display. Step 4. Specify the grid's visibility: Select TRUE for Visible (in the tree under Grid) to display the grid. The default is FALSE. Displays B. Select a color from the palette that appears.
GFK-1260F-1
Designing an XY Plot
6-35
Step 1. Expand the tree under Legends: Do one of the following to expand the tree under Legends: Method 1 Click the to the left of Legends.
6-36
GFK-1260F-1
Method 2 A. Click the right mouse button. B. Click the Expand popup menu
. Method 3 Double click Legends. The tree expands to display the title's property options.
Note: Follow any of the three methods when the tree is expanded to collapse the tree. The popup menu displays as Collapse.
. Step 2. Make the legends visible: 1. 2. 3. Select Visible under Legends. Select TRUE. Click Apply.
Step 3. Specify the legends' location (orientation) relative to the XY Plot: 1. 2. Select Orientation under Legends. Select one of the following to place the legend relative to the chart. Location relative to the chart apOrientationBottom (default) apOrientation Left apOrientationRight apOrientationTop Bottom Left Right Top
GFK-1260F-1
Designing an XY Plot
6-37
Step 4. Design the Series legend: 1. 2. Expand Series under Legends. Specify if the series header should be visible. A. Select HeaderVisible under LegendsSeries. B. Select TRUE to make it visible, FALSE to hide it. 3. Configure the font to display in the series header. A. Select Font under LegendsSeries. B. Either: on the LegendSeries Font row and open the Click the Font button Font dialog box to configure the font, or Set UseAmbientFont under legendsSeries to TRUE. 4. Select a fill for the header's background. A. Select Brush under LegendsSeries. B. Select a color for the header background. Click the down arrow C. Select the brush Type. Type apBrushSolid apBrushHatch Fills the series legend with a: Solid color Hatch (pattern) to the right of the displayed color. Select a color from the palette that appears.
D. Select a HatchStyle for the brush if you selected apBrushHatch as the type. apHatchBackwardDiagonal apHatchCross apHatchDiagonalCross apHatchForwardDiagonal apHatchHorizontal apHatchVertical 5. Configure the Series legend's columns for the XY Plot's series. A. Expand Columns under LegendsSeries. The number of columns currently in the header appears (grayed out) in the Count row. You can add additional columns or delete existing ones. B. Expand Item. Each number that appears represents a column in the order that it displays, from left to right, e.g. 0 represents the column that is furthest left. C. Set Visible to TRUE to make the column visible; FALSE to hide it.
6-38
GFK-1260F-1
D. Specify the type of series' value that appears in the legend column. The options are: Option apLegendColor apLegendSeriesName apLegendSeriesValueAtSlider apLegendSeriesValueAtIndex Shows the Series color Series name Data value that is intersected by a particular slider Data value at a particular index in a series data vector
E. Make specifications when apLegendSeriesValueAtIndex is selected. i. ii. Select TRUE for ShowX to display the series' X values; FALSE to display the series Y values. Enter an Index value that contains the index to the series data value that you want to display. Example If you enter 0 in the Index row, the column will display the first data value (X or Y, depending on the value of ShowX. F. Enter text that displays as the column header in the Header row. The text normally describes the type of value the column is reporting. Set AutoWidth to TRUE to make the column width expand or contract to accommodate the width of its values, or Set AutoWidth to FALSE and enter a value in the Width row. H. Enter a number in the Order row that defines the order in which the column should appear in the legend, from left to right. For example, 0 is the first column at the left of the legend; 1 is to Column 0's right. I. Select a fill for a selected column. i. ii. J. i. ii. 6. Expand Brush under ColumnItem <number>. Click the Palette button on the Color row to select a color. Select Item under LegendsSeries. Click the right mouse button.
iii. Select Add from the popup menu. Format the Series Legend's rows for the XY Plot series. A. Expand Row under LegendsSeries. The number of rows currently in the Series Legend appears (grayed out) in the Count row. B. Enter the maximum number of Series Legend rows that can be visible during runtime in the VisibleCount row.
GFK-1260F-1
Designing an XY Plot
6-39
Step 5. Design the Slider legend's column heading: 1. 2. Expand Slider under Legends. Specify if the slider's header should be visible. A. Select HeaderVisible under LegendsSlider. B. Select TRUE to make it visible, FALSE to hide it. 3. Configure the font to display in the series header. A. Select Font under LegendsSlider. B. Either: i. ii. 5. on the LegendSlider Font row and open the Click the Font button Font dialog box to configure the font, or Set UseAmbientFont under LegendsSlider to TRUE.
Select a fill for the header's background. A. Select Brush under LegendsSlider. B. Select a color for the header background. i. ii. Click the down arrow to the right of the displayed color. Select a color from the palette that appears. Fills the series with a: Solid color Hatch (pattern)
D. Select a HatchStyle for the brush if you selected apBrushHatch as the type. apHatchBackwardDiagonal apHatchCross apHatchDiagonalCross apHatchForwardDiagonal apHatchHorizontal apHatchVertical 5. Configure the legend's columns for the XY Plot's slider. A. Expand Columns under LegendsSlider. The number of columns currently in the header appears (grayed out) in the Count row. You can add additional columns or delete existing ones. B. Expand Item. Each number that appears represents a column in the order that it displays, from left to right, e.g. 0 represents the column that is furthest left. C. Set Visible to TRUE to make the column visible; FALSE to hide it.
6-40
GFK-1260F-1
D. Specify the type of slider's value that appears in the legend. The options are: Option apLegendName apLegendSliderValue Shows the Slider name Value of a slider relative to an axis
E. Make specifications when apLegendSliderValue is selected. Enter an Index value that specifies the axis you want to use. The index is the position of the axis in the X or Y-axis collection. For a vertical slider the axis must be an X-axis; for a horizontal slider, a Y-axis. F. Enter text that displays as the column header in the Header row. The text normally describes the type of value the column is reporting. i. ii. Set AutoWidth to TRUE to make the column width expand or contract to accommodate the width of its values, or Set AutoWidth to FALSE and enter a value in the Width row. A value of 1 is equivalent to 1/100th of a millimeter (when a CimView screen is at 100% zoom). H. Enter a number in the Order row that defines the order in which the column should appear in the legend, from left to right. For example, 0 is the first column at the left of the legend; 1 is to Column 0's right. I. (Optional) Add additional columns. i. ii. J. Select Item under LegendsSlider. Click the right mouse button.
iii. Select Add from the popup menu. Select a fill for a selected column. i. ii. 6. Expand Brush under ColumnItem <number>. Click the Palette button on the Color row to select a color.
Format the Slider Legend's rows for the XY Plot series. A. Expand Row under LegendsSlider. The number of rows currently in the Slider Legend appears (grayed out) in the Count row. B. Enter the maximum number of Slider Legend rows that can be visible during runtime in the VisibleCount row.
GFK-1260F-1
Designing an XY Plot
6-41
Step 1. Expand the tree under Title: Do one of the following to expand the tree under Title: Method 1 Click the to the left of Title.
6-42
GFK-1260F-1
Method 2 A. Click the right mouse button. B. Click the Expand popup menu
. Method 3 Double click Title. The tree expands to display the title's property options.
Note: Follow any of the three methods when the tree is expanded to collapse the tree. The popup menu displays as Collapse
. Step 2. Specify an XY title content: 1. 2. Select Value under Title. Type the title on the Value row.
Step 3. Configure the font for an XY title: 1. 2. Select Font in the tree under Title. Either and configure the font in the Font dialog box. A. Click the Font button The font you configure will be used. B. Set UseAmbientFont to TRUE. The ambient font for the CimEdit screen will be used. The default is TRUE. Step 4. Make an XY title visible: Select TRUE for Visible (in the tree under Title) to display the title. The default is TRUE.
GFK-1260F-1
Designing an XY Plot
6-43
XY Plot Updates
When you make a change in an XY Plot, it automatically updates by default. Turning of the automatic update stops a chart from being refreshed by your configuration. However, other actions, such as moving the dialog box over the chart will invalidate the current settings and cause the screen to refresh itself. This will update the chart to the most current settings. This feature is most useful if you are doing complicated scripting and want to minimize the screen updates. To specify an XY Plot's update method: 1. 2. 3. Open the CIMPLICITY XY Plot Control Properties dialog box. Select AutoUpdate. Select one of the following: True (Default) False XY will automatically update Updates are not automatic
6-44
GFK-1260F-1
Plotting XY Data
GFK-1260H
7-1
Example 2. Create a series through an object other than the XY Plot control object: Series name: Series 1 (displays in an XY Plot control object in a CimView screen) Scripting purpose: Create a series through and object other than the XY Plot Control object model Procedure: 1. 2. 3. 4. 5. 6. Open the CimEdit Properties dialog box for the XY Plot control object. Display the General tab. Enter XY in the Object name field. Open the CimEdit Properties dialog box for and object that is not an XY Plot control. Display the Edit Script tab. Write the following Basic excerpt within a subroutine.
' Access the XY Plot control object: Dim xyPlot As CimGraphLib.DCimGraph Dim screenObjects As GefObjects Set screenObjects = CimGetScreen().Object.Objects Set xyPlot = screenObjects("XY").OleObject
7-2
GFK-1260H
7-3
GFK-1260H
3.
' Access the pair of vectors: Dim data as CimPairData Set data = series.Data
Example 2. Write a subroutine in the XY Plot control object's Properties dialog box: You can alternate the following excerpt for the previous one:
' Access objects directly to resize the vectors: cimOleObj.Series("Series 1").Data.Count = 500
7-4
GFK-1260H
To invoke the Item property to retrieve data you can use either of the following two formats:
X = CimData.Item(n) X = CimData(n)
where n is the location of the data value you are retrieving. To invoke the Item property to set data you can use either of the following two formats:
CimData.Item(n) = X CimData(n) = X
where n is the location of the data value you are setting. Scripting examples for setting individual data values include: Example 1. Access individual data values from the series vectors: Series name: Series 1 Script purpose: Set a point to the third Y data value Procedure: 1. 2. Open the CimEdit Properties dialog box for the XY Plot control object. Display the Edit Script tab.
' Define the point: Dim x As New Point x.Id = "X_POINT"
' Set the point to the third Y data value in the series: x.SetValue = cimOleObj.Series("Series 1").Data.Y(2)
Example 2. Set individual data values from the series vectors to a particular value: Series name: Series 1 Script purpose: Set the fifth X data value to the value of a point Procedure: 1. 2. Open the CimEdit Properties dialog box for the XY Plot control object. Display the Edit Script tab.
7-5
GFK-1260H
3.
' Set the fifth X (which has an index of 4) ' data value in the series: cimOleObj.Series("Series 1").Data.X(4) = x.GetValue
Example 3. Set individual data values from the series vectors to unavailable: Series name: Series 1 Script purpose: Set the fourth y data value to null, the fourth X data value to empty Both operations result in the value being unavailable. Procedure: 1. 2. Open the CimEdit Properties dialog box for the XY Plot control object. Display the Edit Script tab. Write the following Basic excerpt within a subroutine.
' Set the fourth X and Y data values to unavailable ' (either null or empty): cimOleObj.Series("Series 1").Data.Y(3) = Null cimOleObj.Series("Series 1").Data.X(3) = Empty
7-6
GFK-1260H
Example. Push one or more data values: You have a series whose X and Y values are the following: X Y 5 22 10 17 15 9 20 -7 25 22 30 41
The first four pairs of XY values have been removed from the series because the size of the X and Y vectors is fixed. Scripting examples for pushing single and array values include: Example 1.Push one X and one Y value through the end of the series vectors Example 2. Push arrays of X and Y values through the end of the series vectors Example 1. Push one X and one Y value through the end of the series vectors Series name: Series 1 Script purpose: Push an integer and a double value into Series 1 Procedure: 1. 2. 3. Open the CimEdit Properties dialog box for the XY Plot control object. Display the Edit Script tab. Write the following Basic excerpt within a subroutine.
' Create an integer and a double value: Dim x as Integer x = 7 Dim y as Double Y = 22.74
' Push the data into the series object: cimOleObj.Series("Series 1").Data.Push x, y
7-7
GFK-1260H
Example 2. Push arrays of X and Y values through the end of the series vectors Series name: Series 1 Script purpose: Create an array of variant values and an array of double values and push them into Series 1 Procedure: 1. 2. 3. Open the CimEdit Properties dialog box for the XY Plot control object. Display the Edit Script tab. Write the following Basic excerpt within a subroutine.
' Create an array of variant values: Dim x(4) As Variant x(0) = 1 x(1) = Null x(2) = 4.78 x(3) = Empty x(4) = "5.78"
' Create an array of random double values: Randomize Dim y(4) As Double For i = 0 To 4 y(i) = Random(0, 50) Next i
' Push the data into the series object: cimOleObj.Series("Series 1").Data.Push x, y
7-8
GFK-1260H
Example for Single Points To push the values of two single points Option 1 Use the following format to push the values of single points using GetValue:
CimPairData.Push Point.GetValue, Point.GetValue
Option 2 Use the following format to push the values of two points using a combination of Get and Value:
Point.Get CimPairData.Push Point.Value, Point.Value
Example for Array Points To push the values of two array points: Option 1 Use the following format to push the values of two points using GetSafeArray.
CimPairData.Push Point.GetSafeArray, Point.GetSafeArray
Option 2 Use the following format to push the values of two points using a combination of Get and SafeArray.
Point.Get CimPairData.Push Point.SafeArray, Point.SafeArray
Scripting examples for pushing values from single points and array points include:
7-9
GFK-1260H
Example 1. Push one X and one Y value through the end of a series vectors: Series name: Series 1 Script purpose: Push the single values of two CIMPLICITY points into Series 1 Procedure: 1. 2. 3. Open the CimEdit Properties dialog box for the XY Plot control object. Display the Edit Script tab. Write the following Basic excerpt within a subroutine.
' Get two point values: Dim x As New Point x.Id = "X_POINT" Dim y As New Point y.Id = "Y_POINT"
' Push the data into the series object: cimOleObj.Series("Series 1").Data.Push x.GetValue, y.GetValue
Example 2. Push arrays of X and Y values through the end of a series vectors Series name: Series 1 Script purpose: Push the array values of two CIMPLICITY HMI points into Series 1 Procedure: 1. 2. 3. Open the CimEdit Properties dialog box for the XY Plot control object. Display the Edit Script tab. Write the following Basic excerpt within a subroutine.
' Get two point values: Dim x As New Point x.Id = "X_ARRAY_POINT" Dim y As New Point y.Id = "Y_ARRAY_POINT"
' Get the series object: Dim series as CimSeries Set series = cimOleObj.Series("Series 1")
' Push the array data into the series object: series.Data.Push x.GetSafeArray, y.GetSafeArray
7-10
GFK-1260H
7-11
GFK-1260H
Example. Set one or more data values: You have a series whose X and Y values are the following: X Y 5 22 10 17 15 9 20 -7 25 22 30 41
You set the following X and Y values starting at location 2 (index 1): X Y 35 59 40 37 45 21 50 6
The XY values at locations 2 through 5 are updated with the new values. Scripting examples for setting single and array values include: Example 1. Set the fifth location in a series Example 2. Create an array of variant values in a series Example 1. Set the fifth location in a series: Series name: Series 1 Scripting purpose: Set the fifth location (index 4) in Series 1. The X is set to an integer and the Y to a double value. Procedure: 1. 2. 3. Open the CimEdit Properties dialog box for the XY Plot control object. Display the Edit Script tab. Write the following Basic excerpt within a subroutine.
' Create an integer and a double value: Dim x as Integer x = 7 Dim y as Double Y = 22.74
7-12
GFK-1260H
Example 2. Create an array of variant values in a series: Series name: Series 1 Scripting purpose: Create an array of variant values and an array of double values in Series 1. In addition, set the X and Y elements starting with the fifth element (index 4) through the ninth. (It goes all the way through the ninth element because the arrays being pushed have five elements.) Procedure: 1. 2. 3. Open the CimEdit Properties dialog box for the XY Plot control object. Display the Edit Script tab. Write the following Basic excerpt within a subroutine.
' Create an array of variant values: Dim x(4) As Variant x(0) = 1 x(1) = Null x(2) = 4.78 x(3) = Empty x(4) = "5.78"
' Create an array of random double values: Randomize Dim y(4) As Double For i = 0 To 4 y(i) = Random(0, 50) Next i
7-13
GFK-1260H
Example for Single Points To set the values of two single points Option 1 Use the following format to set the values of single points using GetValue:
CimPairData.Set Index, Point.GetValue, Point.GetValue
Option 2 Use the following format to set the values of two points using a combination of Get and Value:
Point.Get CimPairData.Set Index Point.Value, Point.Value
Example for Array Points To set the values of two array points: Option 1 Use the following format to set the values of two points using GetSafeArray.
CimPairData.Set Index, Point.GetSafeArray, Point.GetSafeArray
Option 2 Use the following format to set the values of two points using a combination of Get and SafeArray.
Point.Get CimPairData.Set Index, Point.SafeArray, Point.SafeArray
Scripting examples for setting values from single points and array points include:
7-14
GFK-1260H
Example 1. Set the first location in a series: Series name: Series 1 Scripting purpose: Set the first location (index 0) in Series 1. The values of two CIMPLICITY points are used. Procedure: 1. 2. 3. Open the CimEdit Properties dialog box for the XY Plot control object. Display the Edit Script tab. Write the following Basic excerpt within a subroutine.
' Get two point values: Dim x As New Point x.Id = "X_POINT" Dim y As New Point y.Id = "Y_POINT"
' Set the data in the series object: cimOleObj.Series("Series 1").Data.Set 0, x.GetValue, y.GetValue
Example 2. Set a series with the array values of two CIMPLICITY HMI points: Series name: Series 1 Scripting purpose: Set Series 1 with array values of two CIMPLICITY HMI points. The set starts at the first location up to the smaller of either: the size of the array points or the number of available locations in the series. Procedure: 1. 2. 3. Open the CimEdit Properties dialog box for the XY Plot control object. Display the Edit Script tab. Write the following Basic excerpt within a subroutine.
' Get two point values: Dim x As New Point x.Id = "X_ARRAY_POINT" Dim y As New Point y.Id = "Y_ARRAY_POINT"
' Get the series object: Dim series as CimSeries Set series = cimOleObj.Series("Series 1")
' Set the array data in the series object: series.Data.Set 0, x.GetSafeArray, y.GetSafeArray
7-15
GFK-1260H
GFK-1260H
8-1
8-2
GFK-1260H
XY SmartObject Chart Dialog Box: Series Tab Series box Add a series Delete a series Move a series in the list M Up M Down
Series data
Display the Series Appearance tab Quick options for a series' appearance
GFK-1260H
8-3
Step 1. Add a series to the Series dialog box: 1. Click Add. SeriesX appears in the Series box. where
X equals the next number above the highest SeriesX.
The first series created is Series0. When a series displays in the Series box, the fields in the right side of the Series dialog box become active and ready for configuration. 2. Check the Visible box if you want the series to display on the XY Plot Control.
Step 2. Name the Series: 1. 2. 3. Select the series to be named in the Series box. Enter a name in the Name field. Click Apply.
Result: The name changes in the Series box to reflect your entry. Step 3. Specify the data for the series: 1. Configure the X-axis expression. Either: A. Enter an expression in the X Expression field, or B. Select a point to represent the expression or be included in an expression. i. ii. Click Select a Point to the right of the X Expression field. Select a Point ID.
iii. (Optional) Enhance the Point ID with an expression operator found in the CimEdit. Example Point ID can be \\CIMPDEMO\DEV1550 Point ID in an Expression can be SQR(\\CIMPDEMO\DEV1550) 2. 3. Configure the Y-axis expression by repeating the procedure to configure the Xaxis expression. Specify the Expression Update method. the options are: Timed Enter the number of one of the following options found in the drop down menu: Milliseconds (Ms) Seconds (Sec) Minutes (Min) Hours (Hour) On X expression update How frequently the X expression updates depends how the expression values are configured. e.g. A Point ID that is updated On Change, will update the XY Plot Control whenever it changes.
8-4
GFK-1260H
On Y expression update
How frequently the Y expression updates depends how the expression values are configured. e.g. A Point ID that is updated On Change, will update the XY Plot Control whenever it changes.
Step 4. Specify the series display features: 1. 2. Click Display under the Series box. The Series Appearance dialog box opens. Select the series Type: Select: Standard (Default) Step Scatter 3. Select the line Style. Solid (Default) Dashed Dotted Dashed-Dotted Dashed-DoubleDotted 4. Select the marker (Dot) from the three options: A. Circle B. Square C. Triangle 5. 6. Select the Width for the line and the Marker (dot) edge. Click Apply to For a: A standard series, which is a line between two data values (connects the dots). An X-based step that flows horizontally, then vertically from one data value to the next. A series that has no lines
Result: You return to the XY Plot SmartObject dialog box. Step 5. Apply your series configuration: Click Apply. Result: Your configuration is applied.
GFK-1260H
8-5
XY SmartObject Chart Dialog Box: AxisTab Axis box displays either the X or Y-axis
Axis location
Step 1. Select an X and Y-axis for configuration: 1. 2. Click Axes on the bottom of the Series tab. The Axes tab displays with Axis0 displaying in the Axis box. Check either the Show X Axes or Show Y Axes check box. Result: The Axis0 represents the axis you select, e.g. if you checked the Show X Axes checkbox, Axis0 becomes the X-axis.
8-6
GFK-1260H
Step 2. Specify the X or Y-axis name and limits: 1. 2. 3. 4. 5. 6. Enter a name for the axis in the Name field. When you click Apply , the name will replace Axis0 in the Axis box. Check the Visible check box to display the axis on the XY Plot. Enter an axis title in the Title field. Check the Visible Title check box to display the title you entered on the XY Plot. Enter a Lower and/or Upper limit if you want either to be different from the default of 0 and 100. Specify how the axis should scale during runtime, as follows: Scale Selection Fixed Autoscale During Runtime The limits remain fixed to the values entered in the Lower Limit and Upper Limit fields. XY automatically change the axis limits each time a value goes above or below the existing limit.
Scroll 7. 8. Check the Ticks checkbox to display ticks on the axis being configured. Enter the number of ticks to display. The default is 2.
Step 3. Specify the X or Y-axis format and orientation: 1. Specify the direction of the data flow. A. Leave the Reversed check box blank if you want the data to flow in the standard direction. (upward for a Y-axis, rightward for an X-axis). B. Check the Reversed check box if you want the data flow in the opposite direction (downward for a Y-axis, leftward for an X-axis). 2. Select the location for the X or Y-axis. A. For the X-axis, check the Top or Bottom button. B. For the Y-axis, check the Left or Right button. 3. Select the format in which the labels will display. The choices with default precision entries are: Format Integer (default) Fixed Scientific Compact Absolute Time Relative Time Custom Precision NA 5 5 5 h:mm:ss:tt NA %d Result 33 33.33333 33.33333e+001 33.333 7:00:33 PM 0.5 33
GFK-1260H
8-7
Step 4. Apply your axis configuration: Click Apply Result: Your configuration is applied. Step 5. Configure the other axis: 1. Check Show Y Axis or Show X Axis, whichever represents the axis that still needs to be configured. Result: Axis0 displays in the Axis box. Tip: Check the Show button that represents the axis you just configured. You will see that the name in the Axis box has changed to the name you entered in the Name field for that axis. Step 6. (Optional) Add additional axes: 1. Click Add underneath the Axis box. A dialog box displays asking you whether you want to create an X or Y-axis.
2.
Click the axis you want to create. An AxisN displays where N is the next number up from the last AxisN (unnamed) axis. Example If a named axis and an Axis0 exists, then the next axis created will initially display as Axis1.
3.
Configure the new axis in the same manner that you configured the primary X and Y-axes.
Step 7: Apply your configuration: Click Apply Result: Your configuration is applied.
8-8
GFK-1260H
You can easily enter a title for the XY Plot SmartObject. You can also specify whether the XY Plot SmartObject should use the CimEdit ambient colors. If you decide to choose colors for the Plot Control, you can easily do so in the CIMPLICITY XY Plot Control dialog box. See the "XY Plot and Background Colors" section in the "Designing an XY Plot" chapter in this manual. To name and color an XY Plot SmartObject: 1. 2. 3. Click Chart at the bottom of the Axis tab. The Chart tab displays. Enter a title in the Title field. Specify whether to use CimEdit ambient colors. A. (Optional) Check one or more of the Ambient check boxes to use the CimEdit ambient colors. B. Choose any non-ambient color when you complete using the XY Plot SmartObject dialog box and refine your configuration using the CIMPLICITY XY Plot Control dialog box.
GFK-1260H
8-9
Enter the number of vertical and horizontal lines that will display as the grid
To configure a grid for an XY Plot SmartObject: 1. Click Grid on the bottom of the Chart tab in the XY Plot SmartObject dialog box. The Grid tab of the XY Plot SmartObject dialog 2. 3. Check the Show Grid check box to display the grid on the XY Plot Control. Select the Style from the Style drop down menu. SolidSelect the line width in the Width drop down menu if you choose this option Dashed Dotted (default) Dash Dotted Dash Double Dot 4. Configure the grid's density. A. Enter the number of vertical ticks (lines) that should display for the XY Plot Control grid in the Vertical field. B. Enter the number of horizontal ticks (lines) that should display for the XY Plot Control grid in the Horizontal field. 5. Click Match Axes to display the two horizontal and two vertical grid lines.
8-10
GFK-1260H
Plot 1
X and Y-axes: autoscaled X initial: 0 to 1000000 Y initial: 0 to 1000 Series markers: None Slider initial position: 75 Series pen: Solid, Standard, black, Width: 25
Plot 2
X-axis: Scrolled Y-axis: autoscaled X initial: 0 to 1000000 Y initial: 0 to 1000 Series markers: Square, navy blue, Width: 75 Slider initial position: 40 Series pen: None
Both plots display the same Point ID Values: Axis Point ID X DEV1550 Y DEV1900
GFK-1260H
8-11
A quick description of how to create each chart can clearly demonstrate how to use the XY Plot Control dialog boxes in order to quickly achieve the display you want. The examples were created to help you become familiar with the process. They include only a few of the many configuration options available to you. The Point ID's used in the example are connected to a local PLC. You can use any Point ID that is active in your project. Following are the steps followed to create: Plot 1 and Plot 2.
Configure some Plot 1 basics in the XY Plot SmartObject dialog box. Enhance Plot 1 in the CIMPLICITY XY Plot Control Properties dialog box.
Plot 1
X and Y-axes: autoscaled X initial: 0 to 1000000 Y initial: 0 to 1000 Series markers: None Slider initial position: 75 Series pen: Solid, Standard, black, Width: 25
Step 1. Configure Plot 1 basics in the XY Plot SmartObject dialog box: 1. 2. Place an XY Plot SmartObject on a CimEdit screen. The Series tab of the XY Plot SmartObject dialog box displays. Configure a Series. A. Click Add to add a series to the chart. B. Name the series. (The example name is DEV1550xDEV1900.) C. Check Visible. D. Click Select a Point in the X Expression field. E. Select a Point ID. (The example is \\CIMPDEMO\DEV1550.) F. Click Select a Point in the Y Expression field. G. Select a Point ID. (The example is \\CIMPDEMO\DEV1900.) H. Check On Y expression update. 3. Click Axes.
8-12
GFK-1260H
4.
Configure the X-axis. A. Check Show X Axis. B. Name the axis. (The example is DEV1550.) C. Check Visible. D. Leave the title blank. (Plot 1 X-axis does not have a title.) E. Enter the limits: Lower Upper F. 0 1000000
5.
Configure the Y-axis: A. Check Show Y Axis. B. Name the axis. (The example is DEV1900.) C. Check Visible. D. Enter a title in the Title field. (The example is DEV1900.) E. Check Title Visible. F. Enter the Limits: Lower Upper 0 1000
G. Check Autoscale for the scaling. 6. 7. 8. 9. Click Chart. Keep the defaults. Click Grid. Specify the number of ticks (lines) for the grid: Vertical Horizontal 10. Click OK. Result: The dialog box closes and an XY Plot Control appears on the CimEdit screen. You can display Plot 1 in CimView or you can further enhance it. Step 2. Enhance Plot 1 using the CIMPLICITY XY Plot Control Properties dialog box: 1. 2. 3. 4. 5. Click the right mouse button over the XY Plot Control. Select CIMPLICITY XY Plot Control Object from the popup menu. Select Properties from the extended menu. Select Chart Color. Select the turquoise color from the chart color palette. 4 4
GFK-1260H
8-13
6.
Modify the Series. A. Expand Series. B. Expand Item C. Expand Pen. D. Select Color. E. Select the navy blue color on the pen color palette. F. Select Width. G. Enter 25.
7.
Modify the Fonts. A. Modify the Title font. i. ii. Expand Title. Select Font.
iii. Specify Arial, Bold, 10. B. Modify the Axes fonts. i. ii. Expand X. Expand Item
iii. Expand Ticks. iv. Select Font. v. Select Arial, Regular 9 in the Font dialog box. vi. Expand Y. vii. Expand Item. viii. Expand Title. ix. Select Font. x. Select Arial, Bold, 10 in the Font dialog box. xi. Expand Ticks. xii. Select Font. Select Arial, Regular 9 in the Font dialog box. 8. 9. Click OK. Test the chart in runtime.
8-14
GFK-1260H
Step 2.Enhance Plot 2 in the CIMPLICITY XY Plot Control Properties dialog box.
XY Plot Scatter Example
Plot 2
X-axis: Scrolled Y-axis: autoscaled X initial: 0 to 1000000 Y initial: 0 to 1000 Series markers: Square, navy blue, Width: 75 Slider initial position: 40 Series pen: None
Step 1. Configure Plot 2 basics in the XY Plot SmartObject dialog box: 1. 2. Place an XY Plot SmartObject on a CimEdit screen. Configure a Series. A. Click Add to add a series to the Plot Control. B. Name the series. (The example name is DEV1550xDEV1900.) C. Check Visible. D. Click Select a Point in the X Expression field. E. Select a Point ID. (The example is \\CIMPDEMO\DEV1550.) F. 3. 4. 5. Click Select a Point in the Y Expression field. G. Select a Point ID. (The example is \\CIMPDEMO\DEV1900.) Check On Y expression update. Click Axes. Configure the X-axis. A. Check Show X Axis. B. Name the axis. (The example is DEV1550.) C. Check Visible. D. Enter DEV1550 in the Title field. E. Check Title Visible. F. Enter the limits: Lower Upper 0 1000000
GFK-1260H
8-15
6.
Configure the Y-axis: A. Check Show Y Axis. B. Name the axis. (The example is DEV1900.) C. Check Visible. D. Enter a title in the Title field. (The example is DEV1900.) E. Check Title Visible. F. Enter the limits: Lower Upper 0 1000
G. Check Autoscale for the scaling. 7. 8. 9. Click Chart. Clear the Title field. (Plot 2 does not have a title.) Click Grid.
10. Make sure the Show Grid check box is clear. (Plot 2 does not display a grid.) 11. Click OK. Result: The dialog box closes and an XY Plot Control appears on the CimEdit screen. 12. Move Plot 2 underneath Plot 1. 13. Use CimEdit's graphics features to align and resize the charts. See the chapter "Applying Inanimate Visual Features" in the "CIMPLICITY HMI CimEdit Operation Manual," GFK-1396, for detailed information about aligning and resizing objects in CimEdit. You can display Plot 2 in CimView or you can further enhance it.
8-16
GFK-1260H
Step 2. Enhance Plot 2 in the CIMPLICITY XY Plot Control Properties dialog box: 1. 2. 3. 4. 5. 6. Click the right mouse button over the XY Plot Control. Select CIMPLICITY XY Plot Control Object from the popup menu. Select Properties from the extended menu. Select Chart Color. Select the light green color on the Plot color palette. Modify the Series. A. Expand Series. B. Expand Item. C. Select Type. D. Select apSeriesScatter. E. Expand Markers. F. Select Type. G. Select apMarkerSquare. H. Select Width. I. J. Enter 75. Expand Pen.
K. Select Color. L. Select the navy blue on the pen color palette. 7. Modify the Axes Fonts. A. Expand X. B. Expand Item C. Expand Ticks. D. Select Font. E. Select Arial, Regular 9 in the Font dialog box. F. Expand Y. G. Expand Item. H. Expand Title. I. J. Select Font. Select Arial, Bold, 10 in the Font dialog box.
K. Expand Ticks. L. Select Font. M. Select Arial, Regular 9 in the Font dialog box. 8. 9. Click OK. Test the Plot Control in runtime.
GFK-1260H
8-17
Index
A
Action Invoke method 3-5 Add A line 3-11 AddExpressionLine Method 3-10 AddLoggedExpressionLine Method 3-13 AddLoggedLine Method 3-11 Advanced Configure chart properties 2-39 Allow Point Scrolling 2-41 Ambient Colors And a Trend chart 2-37 Used for XY 6-11 apAxisAutoscaled For an XY Plot axis 6-18 apAxisFixed For an XY Plot axis 6-18 apAxisScrolled For an XY Plot axis 6-18 apBrushHatch For an XY series 6-25, 6-40 For an XY series legend 6-38 apBrushSolid For an XY series 6-25, 6-40 For an XY series legend 6-38 apDirectionBackward For XY 6-14 apDirectionForward For XY 6-14 apHatchforwardDiagonal For an XY series 6-26 apHatchHorizontal For an XY series 6-26 apHatchVertical For an XY series 6-26 apMarkerCircle For XY Plot series 6-26
apMarkerSquare For XY Plot series 6-26 apmarkerTriangle For XY Plot series 6-26 apNumberAbsoluteTime For an XY 6-14 apNumberAbsoluteTimeEx For an XY Plot 6-14 apNumberCompact For an XY 6-14 apNumberCustom For an XY 6-14 Specified for an XY 6-17 ApNumberFixed For an XY 6-14 apNumberInteger For an XY 6-14 apNumberRelativeTime For an XY 6-14 Specified for an XY 6-17 apNumberScientific For an XY 6-14 Specified for an XY 6-17 apOrientationBottom For XY 6-14 apOrientationLeft For XY 6-14 apOrientationRight For XY 6-14 apOrientationTop For XY 6-14 Appearance Of lines on a trend chart 2-8 apPenDash for an XY Plot axis 6-17 For an XY grid line 6-35 For an XY slider 6-31 For XY series line 6-26, 8-5 apPenDashDot For an XY Plot axis 6-17 For an XY grid line 6-35 For an XY slider 6-31 For XY series line 6-26, 8-5 apPenDashDotDot for an XY Plot axis 6-17 For an XY grid line 6-35 For an XY slider 6-31 For XY series line 6-26, 8-5 appenSolid For XY series line 6-26, 8-5 apPenSolid For an XY Plot axis 6-17 For an XY grid line 6-35 For an XY slider 6-31
GFK-1260H
Index-i
apSeriesScatter For an XY 6-25 For an XY Plot 8-5 apSeriesStandard For an XY 6-25 For an XY Plot 8-5 apSeriesStep For an XY 6-25 For an XY Plot 8-5 apSliderHorizontal For an XY 6-31 apSliderVertical For an XY 6-30 Arguments Invalid 3-7 Array Point trends 2-47 Trend a single element 2-47 Trend at a single instant in time 2-47 Array Points Push values for a series 7-9 Arrays Scrolling 1-9 Auto Update 6-44 Logged line 2-12 Auto Update Interval 2-38 Autoupdate A trend line 3-16 Axes Configure with XY Plot SmartObject 8-6 Configured for an XY series 6-27 Designing for an XY 6-12 Finding the properties for an XY 6-12 Name 6-20 Prioritized on an XY 6-20 Properties on XY 6-12 Title 6-21 Title visible on an XY 6-21 Axis Mapping to a line 2-25 Properties 2-27
Brush For an XY series 6-25 BSTR Valid range 3-7 Buttons Backward and forward scroll for an XY 6-19
C
Change Limits And x-axis timing 2-28 Changing chart properties at run-time 1-5 Chart Configure advanced properties 2-39 Configure properties 2-37 Properties 2-37 Chart Color 2-38 ChartColor For XY 6-10 Choose A font 2-51, 6-9 Color Ambient for XY 6-11 And 2-9 And quick line configuration 2-7 And the y-axis 2-35 Background on a chart 2-38 Chart 2-38 Create custom 2-49, 6-6 For an XY series line 6-26 Foreground on a Chart 2-37 Modifying 2-50, 6-8 Of gridlines 2-44 Of XY grid line 6-35 Select a basic color 2-48, 6-6 Colors Ambient and Trend chart 2-37 Column ID And CSV file lines 2-15 Logged line 2-12 Common Time Stamp And CSV file lines 2-15 Format for CSV lines 2-16 Compression For a line 2-21 Server side 2-22 Configure Basic chart properties 2-37 Begin for axis 2-27 CSV file line 2-15 Detailed x-axis 2-31 Expression line 2-11 Logged expression line 2-13 Logged line 2-12 Point line 2-10
B
Background Color on a Chart 2-38 BackgroundColor Designing for XY 6-10 Backward Scroll buttons on an XY 6-19 BackwardScroll For an XY Plot axis 6-19 Base Project Selected for Trending 2-38 BOOL Valid range 3-7
Index-ii
GFK-1260H
Reference file 2-18 X-axis timing 2-28 XY Smart Object Plot Control axes 8-6 XY Smart Object Plot Control series 8-3 Y-axis 2-32 Y-axis details 2-35 Configured X Axis And mapping axes to lines 2-26 Configured Y Axis And mapping axes to lines 2-26 Content Of XY Title 6-43 Count Horizontal lines on XY grid 6-35 Vertical lines on XY grid 6-35 Create A series from the object model 7-1, 7-2 CSV file line 2-15 Expression line 2-11 Logged expression line 2-13 Logged line 2-12 New trend line 2-8 Point line 2-10 Quick trend line 2-7 Reference file 2-18 CSV File Line 2-15 And Common time stamp format 2-16 And unique time stamp format 2-16 Custom Color 2-49, 6-6
D
Data Flow on an XY 6-14 Format type for an XY 6-14 Location on an XY 6-14 Push one or more values 7-6 Setting individual values 7-4 Data Compression Interval start time 2-25 Logged lines 2-23 Non-logged lines 2-22 Data Source For logged line 3-12, 3-14 Datasource Logged line 2-12 Default Lower Limit 2-33 Default Upper Limit 2-33 Define A legend's properties 2-42 DeleteTrendLine Method 3-15 Density Of XY grid 6-35
Design An XY Plot grid 6-34 An XY Plot title 6-42 Axes for an XY 6-12 Legend for an XY 6-36 Series for an XY 6-22 Slider for an XY 6-29 XY Plot overview 6-1 Details X-axis configuration 2-31 Dialog Box Edit method overview 3-6 Dialog Box Section Invoke method 3-5 Disable Expression line scrolling 2-11 Expression logged line scrolling 2-13 Point line scrolling 2-10 Runtime actions 2-46 Display A grid 2-45 A legend 2-43 Gridlines on a chart 2-44 Line style 2-21 Status bar 2-43 Display Format 2-42 Display Height 2-42 Do Setpoint Checkbox in edit method dialog box 3-6 Double Valid range 3-7 Duration And x-axis timing 2-28 Of x-axis time 2-29
E
Enable Runtime actions 2-46 Enable 3-52 Enable logged data request outstanding state events Configuration example 3-52 EnableOutstandingLoggedRequestStateEvent Configuration example 3-52 EnableOutstandingLoggedRequestStateEvent trend method 3-49, 3-50, 3-51 Entries Advanced for invoking a method 3-6 Basic for invoking a method 3-5 Expansion For a line 2-21 Export Reference file 2-19
GFK-1260H
Index
Index-iii
Expression Adding a line for 3-10 Disable expression line scrolling 2-11 Line 2-11 Line and qualified points 2-11 Logged lines scrolling 2-13
H
Hatch Style For an XY slider legend 6-40 HatchStyle For an XY series 6-26, 6-38 Hide For a line 2-21 Horizontal Slider for an XY 6-31 HorizontalCount Lines on XY grid 6-35
F
File Export reference 2-19 File ID And CSV file lines 2-15 Fill For an XY series 6-25 Find Series properties for an XY 6-22 XY Plot axes properties 6-12 XY Plot Slider properties 6-29 XY Plot title properties 6-42 XY grid properties 6-34 Flow Data on an XY 6-14 Font And the x-axis 2-31 And the y-axis 2-35 Choosing 2-51, 6-9 For an XY title 6-43 For the legend 2-43 ForceRedraw Method 3-61 Foreground Color For XY 6-10 Foreground color on a chart 2-37 Format Data for an XY 6-14 Forward Scroll buttons on an XY 6-19 Fully Qualified Points And expression lines 2-11 And logged expression lines 2-14
I
Insert Trend Control chart on a CimEdit Screen 2-1 XY Plot control in a CimEdit Screen 6-2 Inserting the chart object in CimEdit 2-1, 6-2 Integer For an XY 6-14 Using in edit method dialog box 3-6 Invalid Arguments 3-7 Invoke Method Action Creating 3-4 For lines 3-8 Item 7-4
J
Jump Scroll 2-39 Jump to Current Value 2-41 JumpToCurrentTime trend method 3-31
L
Labeled For the x-axis 2-31 For the y-axis 2-36 LeavingOutstandingLoggedRequestStateEvent Configuration example 3-52 LeavingOutstandingLoggedRequestStateEvent trend method 3-52 Legend Designing for an XY 6-36 Display the legend 2-43 Display the legend from the status popup 2-43 Location for XY Plot 6-37 Properties 2-42 Legend Show All 2-40 Limits For an XY Plot axis 6-18 Y-Axis 2-32
G
Graphic Choices 2-48, 6-6 Grid Density 6-35 Designing for an XY 6-34 Display 2-45 Line 6-35 Properties 2-44 Properties on an XY 6-34 Visible 6-35 Group Log Table 2-12
Index-iv
GFK-1260H
Line Add a logged expression line method 3-13 Add an expression line method 3-10 Add logged method 3-11 Autoupdating method 3-16 Change the display style 2-21 Create 2-8 CSV file 2-15 Delete method 3-15 Design for an XY Plot axis 6-17 Display dialog box 2-21 Expression 2-11 For an XY grid 6-35 For an XY series 6-26 For an XY slider 6-31 Hide 2-21 Logged 2-12 Mapping axes to 2-25 Method for deleting 3-15 Methods for 3-8 Point 2-10 Reference Line 2-17 Set compression 3-18 Set display 3-20 Using logged and point data 3-13 Width for an XY Plot axis 6-17 LineID For logged line 3-9, 3-12 Lines properties, Trend 2-6 List Trend methods 3-3 Trend methods 3-1 Location Of data on an XY 6-14 XY Plot legend 6-37 Logged Expression line scrolling 2-13 Group log table 2-12 Line configuration 2-12 Logged Line Data source 3-12, 3-14 Method to add 3-11 long Valid range 3-7
Method AddLoggedExpressionLine 3-13 AddLoggedLine 3-11 DeleteTrendLine 3-15 For adding an expression line 3-10 SetLineAutoupdate 3-16 Method Result For deleting a line 3-15 For expression line 3-11 For logged line 3-9, 3-12 For logged point line 3-14 For setting an automatic line update 3-17 Overview 3-7 Mode For an XY Plot axis 6-18 Modify A color 6-8 A color 2-50 New XY Plot control size 6-3 Multiple Y-axes displayed 2-40
N
Name For an XY series 6-24, 6-29 For XY Plot axis 6-20 For XY Plot slider 6-33 Trend control 3-4 New Trend line 2-8 No Scroll For the x-axis 2-31 Now Minus Days 2-29 Now Minus Time 2-29 Number Format for an XY 6-14 Type defined for an XY 6-15
O
Object Model Create a series 7-1, 7-2 Definition 7-1 ODBC Data source for logged line 3-12, 3-14 Text driver and reference file name 2-19 Open Advanced dialog box for chart properties 2-39 Trend chart properties dialog box 2-5 XY Plot Control Properties dialog box 6-4 Order of Priority Axis on an XY 6-20 Output Argument In edit method dialog box 3-6
M
Map Axis to line 2-25 Markers For an XY series 6-26
GFK-1260H
Index
Index-v
Outstanding state Configuration example 3-52 Overview Configure XY Plot SmartObject 8-3 Designing an XY 6-1 Features for XY Plots 5-3 Plotting XY data 7-1 Trend control axis tab 2-27 Trend control line tab 2-6 Trend methods 3-1 XY Plot SmartObject 8-1 XY Plots 5-1
P
Pages Enabled at Runtime 2-46 Parameter Passing via a point id 3-7 PauseUpdates trend method 3-33 Pen Design for an XY Plot axix 6-17 For an XY grid 6-35 For an XY series 6-26 For an XY slider 6-31 Width for an XY Plot axis 6-17 Percent Configured Y-axis 2-40 Place XY Plot SmartObject 8-2 Plot XY Data Overview 7-1 Point Adding an expression line 3-10 Data with logged line 3-13 Disable point line scrolling 2-10 Line 2-10 Set value from 7-14 Valid range for type 3-7 Points Qualified and expression lines 2-11 Position Of XY slider 6-31 Prioritize Axes on an XY 6-20 Priority Base project selection 2-38 Selected y-axis limits options 2-33 Procedure Add an expression line method 3-10 Basic for invoking a method 3-5, 3-6 Begin axis configuration 2-27 Change the display style of a line 2-21 Configure a logged expression line 2-13 Configure a logged line 2-12 Configure a reference line from a reference file 2-18
Configure an expression line 2-11 Configure basic chart properties 2-37 Configure CSV file line 2-15 Configure x-axis details 2-31 Configure y-axis limits 2-32 Create a custom color 2-49, 6-6 Detailed y-axis configuration 2-35 Disable expression line scrolling 2-11 Disable expression logged line scrolling 2-13 Disable point line scrolling 2-10 Display gridlines on a chart 2-44 Enable/disable properties dialog box tabs for runtime 2-46 For adding a logged expression line method 3-13 For adding a logged line method 3-11 For automatically updating a line method 3-16 For deleting a line method 3-15 Insert a Trend Control chart on a CimEdit Screen 2-1 Insert an XY Plot control in a CimEdit Screen 6-2 Modify a color 6-8 Modify a color 2-50 Open advanced dialog box for chart properties 2-39 Quickly create a line 2-7 Resize a new XY Plot control 6-3 Select a basic color 6-6 Select a basic color 2-48 Specify a font for a trending text item 2-51 Specify a font for an XY Chart text item 6-9 Specify how lines appear on a trend chart 2-8 specify what axis will explain a trend line 2-25 Trend a single element in an array 2-47 Trend an entire array at a single instant in time 2-47 Project Used in Trending 2-38 Properties Configure advanced for a chart 2-39 Configured for a chart 2-37 Finding for an XY Plot series 6-22 Finding for an XY Plot slider 6-29 Finding for an XY grid 6-34 Finding for XY Plot axes 6-12 For a chart's legend 2-42 For a grid 2-44 Grid on an XY 6-34 Of XY Plot title 6-42 Slider on XY 6-29 That identify an XY series 6-24, 6-29 XY axes on XY 6-12 Push One or more data values 7-6 Values from Points 7-9
Index-vi
GFK-1260H
Q
Qualified Points and expression lines 2-11 Points and logged expression lines 2-14 Quick Lines Creating 2-7
R
Ranges Valid for each point type's parameters 3-7 Rapid Trend Retrieval Interval start time 2-25 Logged lines 2-23 Non-logged lines 2-22 Reference File 2-18 Example 2-20 Export 2-19 Reference Line 2-17 Relative Time Specified for an XY 6-17 ResetZoom trend method 3-46 Resize New Trend Control chart 2-3 New XY Plot control 6-3 Series vectors 7-3 Restrictions Reference file name 2-19 Restrrictions On SetLineAutoupdate method 3-16 Retrieval Rapid for trend logged lines 2-23 Rapid for trend non-logged lines 2-22 Runtime Actions And a reference file line 2-18 Enable or disable 2-46
S
Scatter Series for an XY 6-25 Series for an XY Plot 8-5 Scroll Buttons for an XY 6-19 Expression logged lines disabled 2-13 Scroll Buttons Visible on an XY 6-19 Scrolling 1-8 Disable for expression line 2-11 Disable for logged expression line 2-13 Disable for point line 2-10 Disable for the x-axis 2-31 Scrolling behavior Arrays 1-9
ScrollLines trend method 3-34 Select A basic color 6-6 A basic color 2-48 Series Axes 6-27 Configure with XY Plot SmartObject 8-3 Create data values 7-1 Design legend for 6-36 Designing for an XY 6-22 Fill on an XY 6-25 Finding properties for an XY 6-22 Identifying properties 6-24, 6-29 Markers 6-26 On an XY 6-22 Push one or more data values 7-6 Push value from point 7-9 Resize vectors 7-3 Type for an XY 6-25 Server Side Compression 2-22 Set One or more data values 7-11 Values from points 7-14 SetAxisLabel Method 3-39 SetAxisTicks Method 3-30 SetGridState trend method 3-47 SetLegendState trend method 3-28 SetLineAutoupdate Method 3-16 SetLineAutoupdate trend method 3-16 SetLineCompression Method 3-18 SetLineDisplay Method 3-20 SetLineUseChartY trend method 3-44 SetLineVisible trend method 3-24 SetLineYAxis Method 3-40 Setpoint Do setpoint in edit method dialog box 3-6 SetXDuration trend mehtod 3-35 SetXStartTime trend method 3-37 SetYAxisVisible trend method 3-42 Short Valid range 3-7 Show Legend 2-42 Show Most Recent 2-29 Show Property Pages at Runtime 2-46 And a reference file line 2-18 Show Title 2-42 Single Y-axis displayed 2-40 Single Element Trended 2-47 Single Time Duration 2-40 Single X Axis 2-40 Single Y Axis 2-40 Size Changing for a new XY Plot control 6-3
GFK-1260H
Index
Index-vii
Slider Design legends for 6-36 Designing for an XY 6-29 Finding properties for an XY 6-29 Line 6-31 Name 6-33 Position and visibility 6-31 Properties for an XY 6-29 Type 6-30 Slider Grab Margin 2-40 SmartObject Plot Control Configuring example 1 8-12 Configuring example 2 8-15 Smooth For a line 2-21 Standard Series for an XY 6-25 Series for an XY Plot 8-5 Start Date And x-axis timing 2-29 Start Time 2-29 And x-axis timing 2-28 Data compression interval 2-25 Status Display the status bar 2-43 Status Line 2-42 Step For a line 2-21 Series for an XY 6-25 Series for an XY Plot 8-5 Strip Chart 2-39 Style Change for a line 2-21 Of gridlines 2-44 Of line for an XY Plot axis 6-17 Of XY grid line 6-35 Of XY series hatch fill 6-26, 6-38 Of XY series line 6-26 Of XY slider legend hatch fill 6-40 Specify for font 6-9 Specify for font 2-51
T
Tab Legend 2-42 Runtime actions 2-46 Trend control axis 2-27 Trend control line 2-6 Table ID Logged line 2-12 Text Choose a font 6-9 Choose a font 2-51
Ticks For the x-axis 2-31 For the y-axis 2-36 On an XY Plot axis 6-18 Time Stamp Common format for CSV lines 2-16 Unique format for CSV lines 2-16 Timing Configure for x-axis 2-28 Title Content 6-43 Designing for an XY 6-42 Finding XY Plot title properties 6-42 Font 6-43 For XY Plot axis 6-21 Properties on XY 6-42 Visible 6-43 Trend Rapid retrieval for logged lines 2-23 Rapid retrieval for non-logged lines 2-22 Trend charts Inserting in CimEdit 2-1 6-2 Trend Control Naming 3-4 Trend Line Add a logged expression line method 3-13 Add expression line 3-10 Add logged line method 3-11 Autoupdating method 3-16 Delete 3-15 Set compression 3-18 Set Display 3-20 Trend Method Create invoke method action 3-4 Overview 3-1 Trend methods EnableOutstandingLoggedRequestStateEvent method 3-49, 3-50, 3-51 ForceRedraw method 3-61 JumpToCurrentTime method 3-31 LeavingOutstandingLoggedRequestStateEvent method 3-52 PauseUpdates method 3-33 ResetZoom method 3-46 ScrollLines method 3-34 SetAxisLabel method 3-39 SetAxisTicks method 3-30 SetGridState method 3-47 SetLegendState method 3-28 SetLineAutoupdate 3-16 SetLineUseChartY method 3-44 SetLineVisible 3-24 SetLineYAxis method 3-40 SetXDuration method 3-35
Index-viii
GFK-1260H
SetXStartTime 3-37 SetYAxisVisible 3-42 WriteReferenceFile method 3-26 Trend properties Lines 2-6 Trending Run-time actions, Changing chart properties at runtime 1-5 Runtime actions, Scrolling 1-8 Run-time actions, Zooming 1-6 Scrolling behavior, Arrays 1-9 Type Of Series for an XY 6-25 Of XY Plot slider 6-30
Visible And the x-axis 2-31 Axis title on an XY 6-21 Grid on XY 6-35 Markers for XY series 6-26 Scroll buttons on an XY 6-19 XY series in legend 6-24, 6-29 XY title 6-43
W
Wait State Functionality example 3-52 Width Change for a line 2-21 For XY series line 6-27 For XY series markers 6-26 Of an XY grid line 6-35 Of gridlines 2-44 Of line for an XY Plot axis 6-17 Of XY slider 6-31 WriteReferenceFile trend method 3-26
U
Unique Time Stamp And CSV file lines 2-15 Format for CSV lines 2-16 Update Auto 6-44 Use XY Plot SmartObject 8-2 Use Fixed Lines For a grid 2-44 Use Ticks from Axis For a grid 2-44 UseAmbientBackgroundColor For XY 6-11 UseAmbientChartColor For XY 6-11 UseAmbientForegroundColor For XY 6-11
X
X-axis Designing for an XY 6-12 Finding properties for an XY 6-12 Prioritized on an XY 6-20 Properties on an XY 6-12 X-Axis Configure timing 2-28 Detailed Configuration 2-31 XY Plot Legend location 6-37 XY Plot SmartObject Configuring overview 8-3 Overview 8-1 Placing 8-2 XY Plots Overview 5-1 Overview of features 5-3
V
Valid Ranges for each point type 3-7 Value Of XY title 6-43 Push for data 7-6 Push from points 7-9 Set from point 7-14 Setting for individual data 7-4 Vectors Resize for series 7-3 Vertical Slider for an XY 6-30 VerticalCount Lines on XY grid 6-35
Y
Y-axis Designing for an XY 6-12 Finding properties for an XY 6-12 Prioritized on an XY 6-20 Properties on an XY 6-12
GFK-1260H
Index
Index-ix
Y-Axis Configuration 2-32 Configure limits 2-32 Detailed configuration 2-35 Display multiple 2-40 Display single 2-40 Percent configured 2-40 Priority of limits types 2-33
Z
Zooming 1-6
Index-x
GFK-1260H