Iocomp Plot Pack Manual

Transcription

The Standard in Industrial Automation and Scientific Components for Real-Time Applications
Plot Pack Manual
Version 2.0
Version 2.0.8.2 [02/21/02 3:26 PM]
Copyright
This page intentionally left blank
ii
Iocomp Components – Plot Pack Manual
Copyright
Author
Patrick Carroll
Technical Reviewer Todd Oster
Proofreader
Cyrus Edson
Copyright
Copyright  1998-2002 Iocomp Software Incorporated. All rights reserved.
Portions of the software described in this document copyright Microsoft Corporation, Borland
Corporation, and Linus Torvalds. All Rights Reserved.
NO PART OF THIS PUBLICATION MAY BE REPRODUCED, STORED IN A RETRIEVAL
SYSTEM OR TRANSMITTED BY ANY MEANS, ELECTRONIC, MECHANICAL,
PHOTOCOPYING, RECORDING, OR OTHERWISE, WITHOUT WRITTEN PERMISSION FROM
THE PUBLISHER. EXCEPT FOR THE LIMITED WARRANTY AS DESCRIBED IN THE END
USER LICENSE AGREEMENT, THE INFORMATION AND MATERIAL CONTAINED IN THIS
BOOK ARE PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING WITHOUT LIMITATION ANY WARRANTY CONCERNING THE
ACCURACY, ADEQUACY, OR COMPLETENESS OF SUCH INFORMATION OR MATERIAL OR
THE RESULTS TO BE OBTAINED FROM USING SUCH INFORMATION OR MATERIAL
CONTAINED WITHIN THIS MANUAL OR DOCUMENTATION. NEITHER IOCOMP
SOFTWARE NOR THE AUTHOR SHALL BE RESPONSIBLE FOR ANY CLAIMS
ATTRIBUTABLE TO ERRORS, OMISSIONS, OR OTHER INACCURACIES IN THE
INFORMATION OR MATERIAL CONTAINED IN THIS BOOK, AND IN NO EVENT SHALL
IOCOMP SOFTWARE OR THE AUTHOR BE LIABLE FOR DIRECT, INDIRECT, SPECIAL,
INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF SUCH
INFORMATION OR MATERIAL. SOME STATES DO NOT ALLOW LIMITATIONS OF
DURATION OF ANY IMPLIED WARRANTY, SO THE ABOVE LIMITATIONS MAY NOT
APPLY TO YOU.
Trademarks
Iocomp and the Iocomp Logo are registered trademarks of Iocomp Software Incorporated. Microsoft,
Visual Basic, Visual C++, Visual FoxPro, Windows, Microsoft Office, and ActiveX are trademarks or
registered trademarks of Microsoft Corporation. Borland, Delphi, Kylix, C++ Builder, VCL, and CLX
are trademarks or registered trademarks of the Borland Corporation. Linux is a registered trademark of
Linus Torvalds. All other names, products, or marks are trademarks or registered trademarks of their
respective companies.
Initial Printing 03/2001
Manufactured in the United States of America
iii
Table of Contents
Table of Contents
COPYRIGHT -------------------------------------------------------------------------------------------------------- III
TRADEMARKS----------------------------------------------------------------------------------------------------- III
TABLE OF CONTENTS ------------------------------------------------------------------------------------------ IV
CHAPTER 1 - INTRODUCTION--------------------------------------------------------------------------------- 1
VISUAL C++ SPECIAL COMPILER NOTE --------------------------------------------------------------------------- 2
BORLAND DELPHI, KYLIX, AND C++ BUILDER SPECIAL COMPILER NOTE------------------------------------ 3
COMPONENT NAMING CONVENTIONS ------------------------------------------------------------------------------ 3
SOURCE CODE UNIT NAMING CONVENTIONS --------------------------------------------------------------------- 3
CHAPTER 2 - DECIDING WHICH COMPONENT TO USE --------------------------------------------- 4
IPLOT ------------------------------------------------------------------------------------------------------------------- 5
Properties ----------------------------------------------------------------------------------------------------------- 6
Depreciated Properties ------------------------------------------------------------------------------------------- 6
Methods ------------------------------------------------------------------------------------------------------------- 7
Events---------------------------------------------------------------------------------------------------------------- 7
IXYPLOT --------------------------------------------------------------------------------------------------------------- 8
Properties ----------------------------------------------------------------------------------------------------------- 9
Depreciated Properties ------------------------------------------------------------------------------------------- 9
Methods ----------------------------------------------------------------------------------------------------------- 10
Events-------------------------------------------------------------------------------------------------------------- 10
CHAPTER 3 - OVERALL THEORY -------------------------------------------------------------------------- 11
SPECIFIC EXAMPLES: ----------------------------------------------------------------------------------------------Visual Basic/VBA/VBScript -----------------------------------------------------------------------------------Visual C++ ------------------------------------------------------------------------------------------------------C++ Builder-----------------------------------------------------------------------------------------------------Delphi/Kylix -----------------------------------------------------------------------------------------------------PLOT OBJECTS ------------------------------------------------------------------------------------------------------PLOT OBJECT INDEX -----------------------------------------------------------------------------------------------PLOT OBJECT NAME -----------------------------------------------------------------------------------------------GET PLOT OBJECT INDEX BY NAME-----------------------------------------------------------------------------GET PLOT OBJECT NAME BY INDEX ------------------------------------------------------------------------------
12
12
12
13
13
13
13
14
14
14
CHAPTER 4 - AXES ----------------------------------------------------------------------------------------------- 15
SPAN -----------------------------------------------------------------------------------------------------------------MIN AND MAX -----------------------------------------------------------------------------------------------------ROTATED AXES ----------------------------------------------------------------------------------------------------LABEL FORMATS ---------------------------------------------------------------------------------------------------Simple Values---------------------------------------------------------------------------------------------------Exponential Values ---------------------------------------------------------------------------------------------
iv
16
16
17
17
17
17
Table of Contents
Prefix Values -----------------------------------------------------------------------------------------------------17
Date/Time Values ------------------------------------------------------------------------------------------------17
Price32nds---------------------------------------------------------------------------------------------------------17
REVERSE SCALES ----------------------------------------------------------------------------------------------------18
SCALE TYPES ---------------------------------------------------------------------------------------------------------18
Linear --------------------------------------------------------------------------------------------------------------18
Logarithmic Base 10 ---------------------------------------------------------------------------------------------18
LABELSEPARATION --------------------------------------------------------------------------------------------------19
LABELSMARGIN -----------------------------------------------------------------------------------------------------19
LABELSMINLENGTH ------------------------------------------------------------------------------------------------20
LABELSMINLENGTHAUTOADJUST --------------------------------------------------------------------------------21
STACKINGENDSMARGIN --------------------------------------------------------------------------------------------21
TRACKING ------------------------------------------------------------------------------------------------------------22
USER INTERFACE ----------------------------------------------------------------------------------------------------22
CUSTOMIZING TICK LABELS----------------------------------------------------------------------------------------23
Visual Basic Example --------------------------------------------------------------------------------------------23
Visual C++ Example---------------------------------------------------------------------------------------------24
PROPERTIES -----------------------------------------------------------------------------------------------------------25
METHODS -------------------------------------------------------------------------------------------------------------25
EVENTS----------------------------------------------------------------------------------------------------------------25
CHAPTER 5 - DATA VIEW --------------------------------------------------------------------------------------26
CHANNELS ------------------------------------------------------------------------------------------------------------27
ANNOTATIONS -------------------------------------------------------------------------------------------------------27
DATA CURSORS ------------------------------------------------------------------------------------------------------28
LIMITS -----------------------------------------------------------------------------------------------------------------28
LAYER ORDER--------------------------------------------------------------------------------------------------------29
GRIDS -----------------------------------------------------------------------------------------------------------------29
MAJOR AND MINOR LINES ------------------------------------------------------------------------------------------30
STACKED AXES AND GRID LINES ----------------------------------------------------------------------------------31
PROPERTIES -----------------------------------------------------------------------------------------------------------33
METHODS -------------------------------------------------------------------------------------------------------------33
EVENTS----------------------------------------------------------------------------------------------------------------33
CHAPTER 6 - CHANNELS ---------------------------------------------------------------------------------------34
TRACE LINES ---------------------------------------------------------------------------------------------------------35
DATA MARKERS -----------------------------------------------------------------------------------------------------36
INDIVIDUAL DATA MARKERS --------------------------------------------------------------------------------------36
CHANNEL FILL -------------------------------------------------------------------------------------------------------37
TRACKING ------------------------------------------------------------------------------------------------------------37
RING BUFFER ---------------------------------------------------------------------------------------------------------38
DIGITAL CHANNEL SUPPORT ---------------------------------------------------------------------------------------38
ASYNCHRONOUS AND SYNCHRONOUS DATA --------------------------------------------------------------------39
CHANNEL DATA LOGGING------------------------------------------------------------------------------------------40
FASTDRAW -----------------------------------------------------------------------------------------------------------40
iPlot Component Channel: iPlotChannel: --------------------------------------------------------------------43
iXYPlot Component Channel: iPlotXYChannel: -------------------------------------------------------------45
v
Table of Contents
PROPERTIES ---------------------------------------------------------------------------------------------------------- 46
METHODS ------------------------------------------------------------------------------------------------------------ 46
EVENTS --------------------------------------------------------------------------------------------------------------- 46
CHAPTER 7 - LEGEND ------------------------------------------------------------------------------------------ 47
PREDEFINED COLUMNS -------------------------------------------------------------------------------------------TURN ON AND OFF COLUMN TITLES ----------------------------------------------------------------------------PROPERTIES ---------------------------------------------------------------------------------------------------------METHODS -----------------------------------------------------------------------------------------------------------EVENTS ---------------------------------------------------------------------------------------------------------------
48
49
49
49
49
CHAPTER 8 - TOOLBAR ---------------------------------------------------------------------------------------- 50
CONFIGURE INDIVIDUAL BUTTONS ------------------------------------------------------------------------------IMPLEMENTED EXTERNALLY -------------------------------------------------------------------------------------BUTTON DESCRIPTIONS -------------------------------------------------------------------------------------------Resume Button --------------------------------------------------------------------------------------------------Pause Button ----------------------------------------------------------------------------------------------------Axes Scroll Mode Button --------------------------------------------------------------------------------------Axes Zoom Mode Button---------------------------------------------------------------------------------------Zoom In Button--------------------------------------------------------------------------------------------------Zoom Out Button------------------------------------------------------------------------------------------------Select Button-----------------------------------------------------------------------------------------------------Zoom Box Button -----------------------------------------------------------------------------------------------Cursor Button ---------------------------------------------------------------------------------------------------Edit Button-------------------------------------------------------------------------------------------------------Copy Button -----------------------------------------------------------------------------------------------------Save Button ------------------------------------------------------------------------------------------------------Print Button------------------------------------------------------------------------------------------------------PROPERTIES ---------------------------------------------------------------------------------------------------------METHODS -----------------------------------------------------------------------------------------------------------EVENTS ---------------------------------------------------------------------------------------------------------------
51
51
51
51
51
51
51
52
52
52
52
52
52
52
53
53
53
53
53
CHAPTER 9 - ANNOTATIONS -------------------------------------------------------------------------------- 54
ANNOTATION TYPES-----------------------------------------------------------------------------------------------Text ---------------------------------------------------------------------------------------------------------------Line ---------------------------------------------------------------------------------------------------------------Rectangle---------------------------------------------------------------------------------------------------------LineX -------------------------------------------------------------------------------------------------------------LineY--------------------------------------------------------------------------------------------------------------ANNOTATION REFERENCE RELATIONSHIPS---------------------------------------------------------------------DataView Reference--------------------------------------------------------------------------------------------Channel Reference ---------------------------------------------------------------------------------------------MOVEABLE ANNOTATIONS ---------------------------------------------------------------------------------------HOW TO ADD ANNOTATIONS -------------------------------------------------------------------------------------Text Annotation Example--------------------------------------------------------------------------------------Line Annotation Example--------------------------------------------------------------------------------------Rectangle Annotation Example -------------------------------------------------------------------------------vi
55
55
55
55
56
56
57
57
57
58
58
58
58
59
Table of Contents
LineX Example ----------------------------------------------------------------------------------------------------59
LineY Example ----------------------------------------------------------------------------------------------------59
HOW TO REMOVE ANNOTATIONS ----------------------------------------------------------------------------------59
ANNOTATION CLICK EVENT ----------------------------------------------------------------------------------------60
PROPERTIES -----------------------------------------------------------------------------------------------------------60
METHODS -------------------------------------------------------------------------------------------------------------60
EVENTS----------------------------------------------------------------------------------------------------------------60
CHAPTER 10 – DATA CURSORS ------------------------------------------------------------------------------61
CURSOR TYPES -------------------------------------------------------------------------------------------------------61
Value X-Y Cursor [ValueXY] -----------------------------------------------------------------------------------61
Value X Cursor [ValueX] ---------------------------------------------------------------------------------------62
Value Y Cursor [ValueY] ----------------------------------------------------------------------------------------62
Period Cursor [DeltaX] -----------------------------------------------------------------------------------------63
Peak-Peak Cursor [DeltaY] ------------------------------------------------------------------------------------63
Frequency Cursor [InverseDeltaX]----------------------------------------------------------------------------64
ADDING AND REMOVING CURSORS -------------------------------------------------------------------------------64
Data Cursor Example--------------------------------------------------------------------------------------------65
ACCESSING INDIVIDUAL CURSOR PROPERTIES-------------------------------------------------------------------65
Controlling User Popup Menu ---------------------------------------------------------------------------------65
Controlling Hints -------------------------------------------------------------------------------------------------65
Controlling Cursor Pointers ------------------------------------------------------------------------------------65
IPLOT COMPONENT SPECIFIC NOTES ------------------------------------------------------------------------------65
IXYPLOT COMPONENT SPECIFIC NOTES --------------------------------------------------------------------------66
CURSOR EVENTS -----------------------------------------------------------------------------------------------------66
PROPERTIES -----------------------------------------------------------------------------------------------------------67
METHODS -------------------------------------------------------------------------------------------------------------67
EVENTS----------------------------------------------------------------------------------------------------------------67
CHAPTER 11 - LIMITS--------------------------------------------------------------------------------------------68
LINEX -----------------------------------------------------------------------------------------------------------------68
LINEY -----------------------------------------------------------------------------------------------------------------69
BANDX----------------------------------------------------------------------------------------------------------------69
BANDY----------------------------------------------------------------------------------------------------------------70
POLYBANDX ---------------------------------------------------------------------------------------------------------70
PLOYBANDY ---------------------------------------------------------------------------------------------------------71
ADDING AND REMOVING LIMITS ----------------------------------------------------------------------------------71
Single-Line Limit Examples -------------------------------------------------------------------------------------72
Band Limit Examples --------------------------------------------------------------------------------------------72
Poly Band Limit Examples --------------------------------------------------------------------------------------72
PROPERTIES -----------------------------------------------------------------------------------------------------------74
METHODS -------------------------------------------------------------------------------------------------------------74
EVENTS----------------------------------------------------------------------------------------------------------------74
CHAPTER 12 - LABELS ------------------------------------------------------------------------------------------75
HOW TO ADD LABELS -----------------------------------------------------------------------------------------------76
Horizontal Label Example --------------------------------------------------------------------------------------76
vii
Table of Contents
Vertical Label Example ----------------------------------------------------------------------------------------HOW TO REMOVE LABELS ----------------------------------------------------------------------------------------PROPERTIES ---------------------------------------------------------------------------------------------------------METHODS -----------------------------------------------------------------------------------------------------------EVENTS ---------------------------------------------------------------------------------------------------------------
76
76
77
77
77
CHAPTER 13 - VISUAL LAYOUT MANAGER------------------------------------------------------------ 78
TUTORIAL -----------------------------------------------------------------------------------------------------------How to Move Objects ------------------------------------------------------------------------------------------Resizing Plot Objects-------------------------------------------------------------------------------------------How to Stack Axes ----------------------------------------------------------------------------------------------Rotating X and Y-Axes ------------------------------------------------------------------------------------------
79
79
81
83
85
CHAPTER 14 - ADDING DATA -------------------------------------------------------------------------------- 86
ADDXY -------------------------------------------------------------------------------------------------------------- 86
Complete AddXY Example ------------------------------------------------------------------------------------- 86
Visual Basic------------------------------------------------------------------------------------------------------------------------------------------- 86
Visual C++ [Disp Inteface] ------------------------------------------------------------------------------------------------------------------------- 87
Visual C++ [High-Speed iDispatch Interface] --------------------------------------------------------------------------------------------------- 87
C++ Builder------------------------------------------------------------------------------------------------------------------------------------------- 88
Delphi/Kylix ------------------------------------------------------------------------------------------------------------------------------------------ 89
Internet Explorer [Client-Side, VBScript] -------------------------------------------------------------------------------------------------------- 89
Special ActiveX Example: -------------------------------------------------------------------------------------- 90
Visual Basic------------------------------------------------------------------------------------------------------------------------------------------- 91
Visual C++ [Disp Interface] ------------------------------------------------------------------------------------------------------------------------ 91
Visual C++ [High-Speed iDispatch Interface] --------------------------------------------------------------------------------------------------- 92
Internet Explorer [Client-Side, VBScript] -------------------------------------------------------------------------------------------------------- 93
OTHER DATA ADDING METHODS --------------------------------------------------------------------------------ADDYELAPSEDSECONDS -----------------------------------------------------------------------------------------ADDYELAPSEDTIME ----------------------------------------------------------------------------------------------ADDYNOW ---------------------------------------------------------------------------------------------------------ADDXYARRAYS ---------------------------------------------------------------------------------------------------ADDEMPTY ---------------------------------------------------------------------------------------------------------ADDXNULL [IPLOTX COMPONENT ONLY]----------------------------------------------------------------------ADDNULL [IXYPLOTX COMPONENT ONLY] -------------------------------------------------------------------MODIFYING/READING DATA -------------------------------------------------------------------------------------RUNNING Y-VALUE MIN, MAX, AND MEAN -------------------------------------------------------------------EMPTY DATA POINTS -----------------------------------------------------------------------------------------------
93
94
94
94
95
95
95
96
96
97
98
CHAPTER 15 - NULL DATA HANDLING ------------------------------------------------------------------ 99
ADDING A NULL Y DATA POINT AT A SPECIFIC X DATA POINT (IPLOT ONLY) ---------------------------- 99
ADDING A NULL X & Y DATA (IXYPLOT ONLY) -------------------------------------------------------------- 99
SETTING A NULL Y DATA POINT AT A SPECIFIC X DATA POINT -------------------------------------------- 100
FULL SOURCE EXAMPLE ------------------------------------------------------------------------------------------ 100
Visual Basic ----------------------------------------------------------------------------------------------------- 101
Visual C++ [Disp Inteface]----------------------------------------------------------------------------------- 101
Visual C++ [High-Speed iDispatch Inteface] ------------------------------------------------------------- 102
Delphi/Kylix ----------------------------------------------------------------------------------------------------- 103
C++ Builder----------------------------------------------------------------------------------------------------- 103
viii
Table of Contents
Internet Explorer ----------------------------------------------------------------------------------------------- 104
CHAPTER 16 - USER INTERFACE CONTROL---------------------------------------------------------- 105
THE BUILT-IN TOOLBAR ------------------------------------------------------------------------------------------ 105
SCROLLABLE AND ZOOMABLE AXES ---------------------------------------------------------------------------- 106
ZOOMING TOOLS --------------------------------------------------------------------------------------------------- 106
SELECT TOOL------------------------------------------------------------------------------------------------------- 106
CURSOR TOOL ------------------------------------------------------------------------------------------------------ 106
CONTEXT SENSITIVE RIGHT-CLICK MENUS (POPUP MENUS) ------------------------------------------------ 107
Axis Object ------------------------------------------------------------------------------------------------------ 107
DataView Object------------------------------------------------------------------------------------------------ 107
Toolbar Object -------------------------------------------------------------------------------------------------- 107
Legend Object--------------------------------------------------------------------------------------------------- 107
DataCursor Object --------------------------------------------------------------------------------------------- 107
RUNTIME PROPERTY EDITOR ------------------------------------------------------------------------------------- 108
Right-Click on Plot Object ------------------------------------------------------------------------------------ 108
Preventing or Disabling UI Interaction --------------------------------------------------------------------- 108
Disabling All UI Interaction on a Plot Object-------------------------------------------------------------------------------------------------- 108
Disabling Popup Menu on a Plot Object or On Entire Component ------------------------------------------------------------------------- 109
Toolbar Runtime Property Editor Button ------------------------------------------------------------------- 109
CHAPTER 17 - TRACKING------------------------------------------------------------------------------------ 110
TRACKING STYLES------------------------------------------------------------------------------------------------- 111
ScaleMinMax [Y-Axis Default] ------------------------------------------------------------------------------- 111
ScaleMax--------------------------------------------------------------------------------------------------------- 112
ScaleMin --------------------------------------------------------------------------------------------------------- 112
ScrollSmooth [X-Axis Default] ------------------------------------------------------------------------------- 112
Scroll Page ------------------------------------------------------------------------------------------------------ 112
ExpandCollapse ------------------------------------------------------------------------------------------------ 112
TRACKING ALIGN FIRST STYLES--------------------------------------------------------------------------------- 113
Min---------------------------------------------------------------------------------------------------------------- 113
Max --------------------------------------------------------------------------------------------------------------- 113
Auto--------------------------------------------------------------------------------------------------------------- 114
None [All Axis Default]---------------------------------------------------------------------------------------- 114
TRACKING SCROLL COMPRESS MAX ---------------------------------------------------------------------------- 114
ENABLING AND DISABLING TRACKING ------------------------------------------------------------------------- 115
Channel Tracking Properties --------------------------------------------------------------------------------- 116
Axis Tracking Properties -------------------------------------------------------------------------------------- 116
User Interaction ------------------------------------------------------------------------------------------------ 116
Manual Tracking ----------------------------------------------------------------------------------------------- 116
CHAPTER 18 - INTERPOLATION--------------------------------------------------------------------------- 117
NONE ---------------------------------------------------------------------------------------------------------------- 117
STRAIGHT LINE ---------------------------------------------------------------------------------------------------- 118
CUBIC SPLINE ------------------------------------------------------------------------------------------------------ 119
POLYNOMIAL ------------------------------------------------------------------------------------------------------- 120
RATIONAL ---------------------------------------------------------------------------------------------------------- 121
ix
Table of Contents
DIFFERENTIAL ------------------------------------------------------------------------------------------------------ 122
CHAPTER 19 - LOADING AND SAVING DATA --------------------------------------------------------- 123
DATA FORMATS ---------------------------------------------------------------------------------------------------- 123
SaveDataToFile------------------------------------------------------------------------------------------------- 123
LoadDataFromFile--------------------------------------------------------------------------------------------- 124
SavePropertiesToFile ------------------------------------------------------------------------------------------ 124
LoadPropertiesFromFile -------------------------------------------------------------------------------------- 125
DATA LOG FORMATS ---------------------------------------------------------------------------------------------- 125
LogFileName ---------------------------------------------------------------------------------------------------- 125
LogBufferSize --------------------------------------------------------------------------------------------------- 125
LogActivate ------------------------------------------------------------------------------------------------------ 126
LogDeactivate--------------------------------------------------------------------------------------------------- 126
ADDDATAARRAY EXAMPLE ------------------------------------------------------------------------------------- 126
IMAGE FORMATS --------------------------------------------------------------------------------------------------- 127
CHAPTER 20 - GRAPHICAL EXPORT--------------------------------------------------------------------- 128
ENHANCED METAFILEFORMAT ---------------------------------------------------------------------------------- 128
BITMAP -------------------------------------------------------------------------------------------------------------- 128
JPEG ---------------------------------------------------------------------------------------------------------------- 128
PNG ----------------------------------------------------------------------------------------------------------------- 129
GETBYTESJPEG METHOD---------------------------------------------------------------------------------------- 129
CHAPTER 21 - PRINTING ------------------------------------------------------------------------------------- 130
PRINTING OPTIONS ------------------------------------------------------------------------------------------------ 130
Page Orientation ----------------------------------------------------------------------------------------------- 130
Printer Dialog--------------------------------------------------------------------------------------------------- 130
Margins ---------------------------------------------------------------------------------------------------------- 131
SIMPLE CHART PRINT --------------------------------------------------------------------------------------------- 131
USING WITH EXTERNAL REPORTING PACKAGES OR CUSTOM CODE ---------------------------------------- 131
Clipboard Transfer --------------------------------------------------------------------------------------------- 132
IPictureDisp Object Transfer --------------------------------------------------------------------------------- 132
Save to Enhanced Metafile ------------------------------------------------------------------------------------ 132
PRINTING TIPS ------------------------------------------------------------------------------------------------------ 132
CHAPTER 22 - AUTOSCALE AND AUTOLABEL------------------------------------------------------- 133
1-2-5 RULE --------------------------------------------------------------------------------------------------------- 133
MODIFYING THE 1-2-5 RULE ------------------------------------------------------------------------------------- 136
DesiredIncrement----------------------------------------------------------------------------------------------- 136
Desired Start ---------------------------------------------------------------------------------------------------- 137
TRACKING ---------------------------------------------------------------------------------------------------------- 137
CHAPTER 23 - VISUAL C++ DISP VS. IDISPATCH INTERFACE --------------------------------- 138
DISP INTERFACE [LATE BINDING] ------------------------------------------------------------------------------- 138
IDISPATCH INTERFACE [EARLY BINDING] ---------------------------------------------------------------------- 139
CHAPTER 24 - USING WITH DATABASE ---------------------------------------------------------------- 141
x
Table of Contents
INTEGRATED TEXT FILE SAVING AND LOADING --------------------------------------------------------------- 141
SIMPLE X AND Y DATA ------------------------------------------------------------------------------------------- 141
TIME/DATE X AND Y DATA -------------------------------------------------------------------------------------- 141
ADDING VERY LARGE AMOUNTS OF DATA TO THE CHART -------------------------------------------------- 142
CHAPTER 25 - LAYOUT CONTROL THROUGH CODE --------------------------------------------- 143
LAYOUT MANAGER------------------------------------------------------------------------------------------------ 143
LAYOUT OBJECT ZORDER ---------------------------------------------------------------------------------------- 143
LAYOUT OBJECT STARTPERCENT AND STOPPERCENT -------------------------------------------------------- 144
Horizontal Layout Object ------------------------------------------------------------------------------------- 144
Vertical Layout Object----------------------------------------------------------------------------------------- 144
DataViewZVert ------------------------------------------------------------------------------------------------- 145
DataViewZHorz------------------------------------------------------------------------------------------------- 145
TOOLBAR AND LEGEND ------------------------------------------------------------------------------------------- 146
X AND Y-AXES ---------------------------------------------------------------------------------------------------- 146
StackingEndsMargin ------------------------------------------------------------------------------------------- 146
LAYOUT OBJECT HORIZONTAL ---------------------------------------------------------------------------------- 147
FULL LAYOUT THROUGH CODE EAMPLE ----------------------------------------------------------------------- 149
Visual Basic/VBA/VBScript ----------------------------------------------------------------------------------- 150
DELPHI/KYLIX ----------------------------------------------------------------------------------------------------- 151
Visual C++ [Disp Interface] --------------------------------------------------------------------------------- 152
Visual C++ [High-Speed iDispatch Inteface] ------------------------------------------------------------- 153
C++ Builder----------------------------------------------------------------------------------------------------- 155
CHAPTER 26 - PERFORMANCE TUNING---------------------------------------------------------------- 156
COMPONENT SIZE -------------------------------------------------------------------------------------------------- 156
FRAME RATE ------------------------------------------------------------------------------------------------------- 156
AutoFrameRate ------------------------------------------------------------------------------------------------- 157
UpdateFrameRate ---------------------------------------------------------------------------------------------- 157
BeginUpdate----------------------------------------------------------------------------------------------------- 158
EndUpdate------------------------------------------------------------------------------------------------------- 158
SYSTEM HARDWARE ---------------------------------------------------------------------------------------------- 158
Processor -------------------------------------------------------------------------------------------------------- 158
Memory ---------------------------------------------------------------------------------------------------------- 159
Video Card ------------------------------------------------------------------------------------------------------ 159
Special ActiveX Example: ------------------------------------------------------------------------------------- 159
Visual Basic----------------------------------------------------------------------------------------------------------------------------------------Visual C++ [Disp Interface] ---------------------------------------------------------------------------------------------------------------------Visual C++ [High-Speed iDispatch Interface] ------------------------------------------------------------------------------------------------Internet Explorer [Client-Side, VBScript] ------------------------------------------------------------------------------------------------------
160
161
162
163
CHAPTER 27 - MEMORY UTILIZATION----------------------------------------------------------------- 164
DATA STORAGE ---------------------------------------------------------------------------------------------------- 164
Memory Usage Calculations---------------------------------------------------------------------------------- 164
2GB Application RAM Barrier ------------------------------------------------------------------------------- 165
RESOURCE MEMORY VS. RAM MEMORY ---------------------------------------------------------------------- 165
RAM Memory --------------------------------------------------------------------------------------------------- 165
Resource Memory ---------------------------------------------------------------------------------------------- 165
xi
Table of Contents
RING BUFFER ------------------------------------------------------------------------------------------------------- 166
CHAPTER 28 - IMPLEMENTING TOOLBAR EXTERNALLY -------------------------------------- 168
RESUME BUTTON -------------------------------------------------------------------------------------------------- 168
PAUSE BUTTON ---------------------------------------------------------------------------------------------------- 168
AXES SCROLL MODE BUTTON ----------------------------------------------------------------------------------- 168
AXES ZOOM MODE BUTTON ------------------------------------------------------------------------------------- 168
ZOOM IN BUTTON -------------------------------------------------------------------------------------------------- 168
ZOOM OUT BUTTON ----------------------------------------------------------------------------------------------- 169
SELECT BUTTON --------------------------------------------------------------------------------------------------- 169
ZOOM BOX BUTTON ----------------------------------------------------------------------------------------------- 169
CURSOR BUTTON -------------------------------------------------------------------------------------------------- 169
EDIT BUTTON------------------------------------------------------------------------------------------------------- 169
COPY BUTTON------------------------------------------------------------------------------------------------------ 169
SAVE BUTTON ------------------------------------------------------------------------------------------------------ 169
PRINT BUTTON ----------------------------------------------------------------------------------------------------- 169
CHAPTER 29 - IMPLEMENTING LEGEND EXTERNALLY ---------------------------------------- 170
CHANNEL NAME LISTING ----------------------------------------------------------------------------------------- 170
CHANNEL TRACE LINE STYLE AND COLOR LISTING ---------------------------------------------------------- 171
CHANNEL MARKER STYLE AND COLOR LISTING -------------------------------------------------------------- 172
CHANNEL ASSOCIATED X-AXIS --------------------------------------------------------------------------------- 173
CHANNEL ASSOCIATED Y-AXIS --------------------------------------------------------------------------------- 173
CHANNEL CURRENT X/Y COORDINATE ------------------------------------------------------------------------ 173
CHAPTER 30 - ASP (ACTIVE SERVER PAGES) -------------------------------------------------------- 174
CHAPTER 31 - INTERNET EXPLORER (CLIENT SIDE) --------------------------------------------- 175
CREATING THE PLOT PACK ACTIVEX OBJECT IN YOUR WEB PAGE ---------------------------------------- 175
ClassID List for Plot Pack Components--------------------------------------------------------------------- 176
INSTALLING THE PLOT PACK ACTIVEX CONTROL ON THE CLIENT ------------------------------------------ 176
LICENSING THE PLOT PACK ACTIVEX CONTROL -------------------------------------------------------------- 177
ACCESSING THE PLOT PACK ACTIVEX CONTROL FROM VBSCRIPT----------------------------------------- 177
FULL SOURCE EXAMPLE ------------------------------------------------------------------------------------------ 178
APPENDIX A - PLOT PACK PROPERTY EDITORS --------------------------------------------------- 179
CONTROL GENERAL ----------------------------------------------------------------------------------------------- 179
CONTROL TITLE ---------------------------------------------------------------------------------------------------- 181
CONTROL PRINT---------------------------------------------------------------------------------------------------- 182
CONTROL HINTS --------------------------------------------------------------------------------------------------- 183
CONTROL FILE I/O------------------------------------------------------------------------------------------------- 184
TRANSLATION ------------------------------------------------------------------------------------------------------ 185
ANNOTATION DEFAULTS------------------------------------------------------------------------------------------ 186
CHANNELS GENERAL ---------------------------------------------------------------------------------------------- 189
CHANNEL TRACE -------------------------------------------------------------------------------------------------- 191
INTERPOLATION ---------------------------------------------------------------------------------------------------- 192
CHANNELS MARKERS --------------------------------------------------------------------------------------------- 193
xii
Table of Contents
CHANNELS FILL ---------------------------------------------------------------------------------------------------- 195
CHANNELS DIGITAL ----------------------------------------------------------------------------------------------- 197
CHANNEL FILE I/O------------------------------------------------------------------------------------------------- 198
CURSORS GENERAL ----------------------------------------------------------------------------------------------- 199
CURSORS HINT ----------------------------------------------------------------------------------------------------- 202
CURSORS MENU ITEMS-------------------------------------------------------------------------------------------- 203
LIMITS GENERAL -------------------------------------------------------------------------------------------------- 205
AXES GENERAL ---------------------------------------------------------------------------------------------------- 210
AXES TITLE --------------------------------------------------------------------------------------------------------- 213
AXES LABELS ------------------------------------------------------------------------------------------------------ 214
AXES TRACKING --------------------------------------------------------------------------------------------------- 216
AXES CURSOR ------------------------------------------------------------------------------------------------------ 218
AXES SCROLL ------------------------------------------------------------------------------------------------------ 219
AXES SCALE -------------------------------------------------------------------------------------------------------- 220
LEGEND ------------------------------------------------------------------------------------------------------------- 221
TOOLBAR ----------------------------------------------------------------------------------------------------------- 224
DATA VIEW --------------------------------------------------------------------------------------------------------- 227
LABELS -------------------------------------------------------------------------------------------------------------- 229
APPENDIX B - ACTIVEX HTML PROPERTIES AND EVENTS ------------------------------------ 231
HTML PAGE IMPORTANT NOTES-------------------------------------------------------------------------------- 231
Boolean Values: ------------------------------------------------------------------------------------------------ 231
Double Values:-------------------------------------------------------------------------------------------------- 231
PROPERTIES --------------------------------------------------------------------------------------------------------- 231
VBSCRIPT EVENTS ------------------------------------------------------------------------------------------------ 238
JAVASCRIPT EVENTS ---------------------------------------------------------------------------------------------- 239
LPK FILE TUTORIAL ---------------------------------------------------------------------------------------------- 242
Web Page ActiveX Licensing: What is an LPK File? ----------------------------------------------------- 242
Steps to create an LPK File...--------------------------------------------------------------------------------- 243
APPENDIX C -- WHAT IS DATETIME FORMAT? ----------------------------------------------------- 247
APPENDIX E -- FREQUENTLY ASKED QUESTIONS ------------------------------------------------- 250
INDEX---------------------------------------------------------------------------------------------------------------- 251
xiii
Table of Contents
This page intentionally left blank
xiv
Chapter 1 - Introduction
Welcome to the Iocomp Plot Pack Manual. This manual, in addition to our help files and example
source code projects included on our website, provides a full suite of documentation for understanding
how our Plot Pack components are constructed, operate, and are used to enhance the applications you
develop.
The Plot Pack currently includes two components: the iPlot component which is designed for
y = f(x) (Incrementing X Values) types of plotting data and the iXYPlot component which is designed
for plotting data that does not follow this equation and may have multiple Y solutions for any given X
value.
This manual is broken up into several chapters covering different aspects of the Plot Components. The
components have been designed entirely on an object oriented approach, making them well suited for
both simple and complex charting applications while leaving themselves open to the addition of many
features and enhancements. The following icons are used throughout the manual for emphasis…
Important Note:
!
Useful Tip:
Reminder:
Sample Code Conventions
All simple examples are formatted using a Visual Basic-like syntax. Depending upon your
compiler, the syntax of accessing plot objects and properties may differ. Some specific examples
for each major development environment are provided, formatted for that specific compiler.
As an example, to access the TitleText property for the first X-Axis you would use the following
different syntax for these major development environments…
Microsoft Visual Basic/VBA/VBScript
iPlotX1.XAxis(0).Title = "Sample Title"
Borland Delphi/Kylix
iPlot1.XAxis[0].Title := 'Sample Title';
Microsoft Visual C++
m_iPlotX1.GetXAxis(0).SetTitle("Sample Title"); //Disp Interface
m_iPlotX1->XAxis[0]->Title = "Sample Title"; //iDispatch Interface
Borland C++ Builder
iPlot1->XAxis[0]->Title = "Sample Title";
1
Visual C++ Special Compiler Note
You will need to include several ActiveX wrapper header files in your include statements to
access Plot Component sub objects…
//include the following for iPlotX
#include "iplotx.h"
#include "iplotchannelx.h"
//include the following for iXYPlotX
#include "ixyplotx.h"
#include "ixyplotchannelx.h"
//include the following for iPlotX and iXYPlotX
#include "iplotaxisx.h"
#include "iplotlegendx.h"
#include "iplottoolbarx.h"
#include "iplotdataviewx.h"
#include "iplotannotationx.h"
#include "iplotlabelx.h"
#include "iplotlimitx.h"
#include "iplotdatacursorx.h"
Enumerated types of ActiveX controls are only supported by Visual C++ if you are using the
high-speed iDispatch interface to an ActiveX control. Refer to the chapter on Visual C++ Disp
vs. iDispatch Interface for more information on using the high-speed iDispatch interface. Refer
to the help file for values associated with enumerated properties if you are using the Disp
Interface.
Microsoft Visual C++ does not support integration of our help files in to the Visual C++ IDE.
You can view our help files through one of the following methods…
1. Click on your START menu button, select Programs, and then Iocomp. In this folder you
will find links to our help files for our ActiveX and VCL/CLX components as well as links to
release notes, website information, and a link to the directory where our products are
installed.
2. Navigate to the folder where you installed our products (generally c:\iocomp\product or
c:\program files\iocomp\components). In this folder are our ActiveX and VCL help files
which you can open directly as well as release notes, and the actual component binaries and
source files.
3. Download one of the appendices listed in this manual for the ActiveX and VCL help. These
appendices contain the same information in the ActiveX and VCL help files, but has been
formatted for printing.
2
Borland Delphi, Kylix, and C++ Builder Special Compiler Note
You will need to include “iTypes” in your USE statement to access enumerated types of
components.
You should be sure to use our VCL/CLX version of our components
since this is the native source code of our products. The ActiveX
versions are simply VCL components wrapped with the Delphi DAX
framework to make them compatible with ActiveX development
environments. If you use our VCL/CLX version, you will be able to
take advantage of special Delphi, Kylix, and C++ Builder VCL/CLX
features such as the ability to compile the components into your
application binary.
Component Naming Conventions
This manual covers the ActiveX, VCL, and CLX component versions of our components. Since
these three component architectures differ in many ways, the actual class names of these
components differ slightly.
If we are talking generically about a component, we will refer to the Plot Components as iPlot
and iXYPlot. In the ActiveX version of the components, the actual class names are iPlotX and
iXYPlotX. In the VCL and CLX versions, the class names are TiPlot and TiXYPlot.
You can extrapolate this to all of the components produced by Iocomp Software. All VCL and
CLX components start with "Ti" and do not end in "X". All ActiveX components start with I
and end in "X".
Source Code Unit Naming Conventions
The source of our components is written in Borland Delphi for Windows and Borland Kylix for
Linux, corresponding to the VCL and CLX versions of our components respectively. The source
code is identical between these two component standards, minus some IFDEF differences that
you will see in the source. The major difference is in the naming of the Unit files. All VCL
component Unit files start with "i". All CLX component Unit file names are the same with "Q"
appended on the front. The class names of the components are still the same. Delphi and Kylix
can decipher the difference between the VCL and CLX versions due to their inheritance which is
dictated by our iInclude.inc file and corresponding IFDEFs.
3
Chapter 2 - Deciding Which Component To Use
The Plot Pack includes several different components for your charting applications. Each component
has been designed for a particular type of chart.
Feature
Unlimited number of Channels
Unlimited number of Data Cursors
Unlimited number of Limits
Channel Ring Buffers
Annotations (Text, Line, and Rectangle)
Unlimited number of X&Y-Axes
Built in Toolbar and Legend
Linear and Logarithmic Scales
Reversible Scales
Value, Prefix, Exponent, and Data/Time Scale
Label styles
Horizontal or Vertical orientation of Axes
Data Point Markers
Intelligent AutoScale of Axes in human
readable format (1-2-5 Rule)
Visual Layout manager (Design-Time and
Run-Time)
Stackable Scales (See Visual Layout
Manager)
Printing, Saving, Picture interface, and
CopyToClipBoard
Automated Data Logging to Disk
Single-Line Cursor
Cross-Hair Cursor
Data Fill
Optimized Drawing Routines for Large Data
Sets
Data Set restricted to y = f(x)
Data Drill Down
Interpolation
iPlot
iXYPlot
Wondering why the iXYPlot component has such as strange name? This
component was named this way to help our ActiveX customers. If the class
name had been named iPlotXY then under ActiveX the component class would
have been iPlotXYX, which would have been confusing.
4
The following ActiveX, VCL and CLX components are included with the Plot Pack…
iPlot
The iPlot component has been designed for y = f(x) based graphs. Supports data with a continuously
incrementing x-value. Typical uses are for Strip Chart, Chart Recorder, or Scrolling Chart types of
plotting applications. This is the chart that should be used for almost all plotting applications.
The Plot component also supports data fill (see Channel #1 example above) to a specified reference
line as well as specialized AddData functions for time based data.
Drawing routines have been optimized in this component to provide high-speed access and drawing
(paint and scroll) operations. This is made possible due to the fact that the data sets need to follow
the for y = f(x) function.
The iPlot main interface contains several properties, methods, and events that affect the overall
appearance and operation of the entire component.
5
Properties
AnnotationDefaultBrushColor
AnnotationDefaultFont
AnnotationDefaultPenWidth
BackGroundColor
Channel
DataView
HintsFontColor
HintsPause
Legend
LogFileName
OuterMarginBottom
OuterMarginTop
PrintMarginRight
PrintShowDialog
UserCanEditObjects
YAxis
AnnotationDefaultBrushStlye
AnnotationDefaultPenColor
Annotation
BackGroundPicture
ComponentHandle
DataViewZHorz
HintsFont
HintsShow
Limit
Logging Active
OuterMarginLeft
PrintMarginBottom
PrintMarginTop
ToolBar
XAxis
AnnotationDefaultFontColor
AnnotationDefaultPenStlye
AutoFrameRate
BorderStyle
DataCursor
DataViewZVert
HintsHidePause
Labels
LogBufferSize
OptionSaveAllProperties
OuterMarginRight
PrintMarginLeft
PrintOrientation
UpdateFrameRate
XYAxesReverse
Refer to the Plot Object Sections for properties of the Plot Objects. These properties are only for the main plot
interface. Refer to Appendix C & D for more detailed information about the iPlot main interface properties.
Depreciated Properties
The following properties have been depreciated due to the inclusion of newer functionality
provided. These properties are provided for backward compatibility only.
TitleFontColor
TitleText
6
TitleFont
TitleVisible
TitleMargin
Methods
AddAnnotation
AddDataCursor
AddLegend
AddTranslation
AnnotationCount
ClearAllData
DataViewCount
DeleteChannel
DeleteLabel
DeleteToolBar
DeleteYAxis
EnableAllTracking
GetBytesJPEG
GetSnapShotPicture
GetXAxisIndexByName
LegendCount
LoadPropertiesFromFile
LogActivate
RemoveAllAnnotations
RemoveAllDataViews
RemoveAllLimits
RemoveAllYAxes
SaveImageToBitmap
Save
ToolBarCount
XAxisCount
AddChannel
AddDataView
AddLimit
AddXAxis
BeginUpdate
CopyToClipBoard
DeleteAllTranslations
DeleteDataCursor
DeleteLegend
DeleteTranslation
DisableAllTracking
EnableLayoutManager
GetChannelIndexByName
GetTranslationOriginalString
GetYAxisIndexByName
LimitCount
LoadTranslationsFromFile
LogDeactivate
RemoveAllChannels
RemoveAllLabels
RemoveAllToolBars
RepaintAll
SaveImageToJPEG
SavePropertiesToFile
TranslationCount
YAxisCount
AddDataArray
AddLabel
AddToolBar
AddYAxis
ChannelCount
DataCursorCount
DeleteAnnotation
DeleteDataView
DeleteLimit
DeleteXAxis
DisableLayoutManager
EndUpdate
GetNow
GetTranslationReplacementString
LabelCount
LoadDataFromFile
Lock
PrintChart
RemoveAllDataCursors
RemoveAllLegends
RemoveAllXAxes
SaveDataToFile
SaveImageToMetaFile
SaveTranslationsToFile
Unlock
Refer to the Plot Object Sections for methods of the Plot Objects. These methods are only for the main plot interface. Refer
to Appendix C and D for more detailed information about the iPlot main interface methods.
Events
OnAfterPrint
OnClickDataPoint
OnKeyPress
OnMouseMove
OnXAxisMinChange
OnYAxisMinChange
OnBeforePrint
OnDataCursorChange
OnKeyUp
OnMouseUp
OnXAxisSpanChange
OnYAxisSpanChange
OnClickAnnotation
OnKeyDown
OnMouseDown
OnXAxisCustomizeLabel
OnYAxisCustomizeLabel
Refer to Appendix C and D for more detailed information about the iPlot main interface events.
7
iXYPlot
The iXYPlot component has been designed for graphs that don’t have continuously incrementing
x-values, and are not based on a y = f(x) function. Since we don’t restrict that the graph be
based on a y = f(x) function, there are some features that are not included or are different
between the iXYPlot component and the iPlot component such as…
Null Data Handling: to specify a null data point (for inserting in breaks between trend line point
to point connections or for signifying that a null data point exists), you will first have to add
dummy data for a null data point and then set that data point to null.
Drawing Routines: the drawing routines in the iXYPlot component are not as optimized as in
the iPlot component since each channel is not based on y = f(x). For large data sets, performance
may be sluggish. Use the iPlot component whenever possible if your data is based on y = f(x)
and you are using large data sets.
Channel Fill: Since there can be any number of Y values for a particular X value, it is not
possible to fill below or above a curve that can fit to these data points.
Interpolation: Since there can be any number of Y values for a particular X value, it is not
possible to perform interpolation or curve fitting functions to the channel data.
Speed: Special speed enhancements are included in the iPlot component that require the data
added to it to be based on y = f(x) . The iXYPlot component will lose some speed improvements
with large data sets.
8
The iXYPlot main interface contains several properties, methods, and events that affect the
overall appearance and operation of the entire component.
Properties
AnnotationDefaultBrushColor
AnnotationDefaultFont
AnnotationDefaultPenWidth
BackGroundColor
Channel
DataView
HintsFontColor
HintsPause
Legend
LogFileName
OuterMarginBottom
OuterMarginTop
PrintMarginRight
PrintShowDialog
UserCanEditObjects
YAxis
AnnotationDefaultBrushStlye
AnnotationDefaultPenColor
Annotation
BackGroundPicture
ComponentHandle
DataViewZHorz
HintsFont
HintsShow
Limit
Logging Active
OuterMarginLeft
PrintMarginBottom
PrintMarginTop
ToolBar
XAxis
AnnotationDefaultFontColor
AnnotationDefaultPenStlye
AutoFrameRate
BorderStyle
DataCursor
DataViewZVert
HintsHidePause
Labels
LogBufferSize
OptionSaveAllProperties
OuterMarginRight
PrintMarginLeft
PrintOrientation
UpdateFrameRate
XYAxesReverse
Refer to Appendix C and D for more detailed information about the iXYPlot main interface properties.
Depreciated Properties
The following properties have been depreciated due to the inclusion of newer functionality
provided. These properties are provided for backward compatibility only.
TitleFontColor
TitleText
TitleFont
TitleVisible
TitleMargin
9
Methods
AddAnnotation
AddDataCursor
AddLegend
AddToolBar
AddYAxis
ChannelCount
DataCursorCount
DeleteAnnotation
DeleteDataView
DeleteLimit
DeleteXAxis
DisableLayoutManager
EndUpdate
GetNow
GetTranslationReplacementString
LabelCount
LimitCount
LoadTranslationsFromFile
LogDeactivate
RemoveAllChannels
RemoveAllLabels
RemoveAllToolBars
RepaintAll
SaveImageToJPEG
TranslationCount
YAxisCount
AddChannel
AddDataView
AddLimit
AddTranslation
AnnotationCount
ClearAllData
DataViewCount
DeleteChannel
DeleteLabel
DeleteToolBar
DeleteYAxis
EnableAllTracking
GetBytesJPEG
GetSnapShotPicture
GetXAxisIndexByName
LegendCount
LoadDataFromFile
Lock
PrintChart
RemoveAllDataCursors
RemoveAllLegends
RemoveAllXAxes
SaveDataToFile
SaveImageToMetaFile
SaveTranslationsToFile
Unlock
AddDataArray
AddLabel
AddNull
AddXAxis
BeginUpdate
CopyToClipBoard
DeleteAllTranslations
DeleteDataCursor
DeleteLegend
DeleteTranslation
DisableAllTracking
EnableLayoutManager
GetChannelIndexByName
GetTranslationOriginalString
GetYAxisIndexByName
LimitCount
LogActivate
RemoveAllAnnotations
RemoveAllDataViews
RemoveAllLimits
RemoveAllYAxes
SaveImageToBitmap
Save
ToolBarCount
XAxisCount
Refer to the Plot Object Sections for methods of the Plot Objects. These methods are only for the main plot
interface. Refer to Appendix C and D for more detailed information about the iPlot main interface methods.
Events
OnAfterPrint
OnClickDataPoint
OnKeyPress
OnMouseMove
OnXAxisMinChange
OnYAxisMinChange
10
OnBeforePrint
OnDataCursorChange
OnKeyUp
OnMouseUp
OnXAxisSpanChange
OnYAxisSpanChange
OnClickAnnotation
OnKeyDown
OnMouseDown
Chapter 3 - Overall Theory
The Plot Pack components are object-oriented components that are designed for very high speed plotting
and ease of use by both the application programmer and application user.
The hierarchy of the Plot Pack components is shared among the many different types of plotting
components that we offer. This allows programmers to use or Plot Components interchangeably since
most of the properties, objects, and methods are common. There are several objects that make up the
base for our Plot Components, and the hierarchy is as follows…
iPlot or iXYPlot
Plot Objects
DataView
XAxis
iPlotAxis
ToolBar
Channel
Legend
Annotation
DataCursor
Limit
Label
Translation
YAxis
There can be any number of Plot Objects associated with each Plot Component. This gives rise to our
Multiple Axes, Multiple Annotations, Multiple Labels, and Multiple Channel features. To access one of
these Plot Component sub-objects, you would need to specify the index value of that object. For
example…
Generic Example:
iComponent1.PlotObject(0).Property = Value
The iPlotAxis object is the ancestor of the iPlotXAxis and iPlotYAxis (Shown
above as XAxis and YAxis) objects. It should not be accessed directly. To
work with the X and/or Y-Axis, use the X-Axis and Y-Axis interfaces instead.
11
Specific Examples:
Visual Basic/VBA/VBScript
iComponentX1.DataView(0).GridShow
iComponentX1.XAxis(0).Min
iComponentX1.YAxis(0).Min
iComponentX1.Channel(0).Name
iComponentX1.Legend(0).Visible
iComponentX1.ToolBar(0).ShowEditButton
iComponentX1.Annotation(0).Text
iComponentX1.DataCursor(0).Style
iComponentX1.Limit(0).XAxisName
iComponentX1.Labels(0).Caption
=
=
=
=
=
=
=
=
=
=
TRUE
100
100
"Channel 1"
TRUE
FALSE
"Sample Annotation"
ipcsDeltaX
"X-Axis 1"
"Chart Y vs. Time"
Visual C++
//Disp Interface
m_iComponentX1.GetDataView(0).SetGridShow(TRUE);
m_iComponentX1.GetXAxis(0).SetMin(100);
m_iComponentX1.GetYAxis(0).SetMin(100);
m_iComponentX1.GetChannel(0).SetName("Channel 1");
m_iComponentX1.GetLegend(0).SetVisible(TRUE);
m_iComponentX1.GetToolBar(0).SetShowEditButton(FALSE);
m_iComponentX1.GetAnnotation(0).SetText("Sample Annotation");
m_iComponentX1.GetDataCursor(0).SetStyle(3); //ipcsDeltaX
m_iComponentX1.GetLimit(0).SetXAxisName("X-Axis 1");
m_iComponentX1.GetLabels(0).SetCaption("Chart Y vs. Time");
//iDispatch Interface
iComponentX1->DataView[0]->GridShow
iComponentX1->XAxis[0]->Min
iComponentX1->YAxis[0]->Min
iComponentX1->Channel[0]->Name
iComponentX1->Legend[0]->Visible
iComponentX1->ToolBar[0]->ShowEditButton
iComponentX1->Annotation[0]->Text
iComponentX1->DataCursor[0]->Style
iComponentX1->Limit[0]->XAxisName
iComponentX1->Labels[0]->Caption
12
=
=
=
=
=
=
=
=
=
=
TRUE;
100;
100;
"Channel 1";
TRUE;
FALSE;
"Sample Annotation";
ipcsDeltaX;
"X-Axis 1";
"Chart Y vs. Time";
C++ Builder
iComponent1->DataView[0]->GridShow
iComponent1->XAxis[0]->Min
iComponent1->YAxis[0]->Min
iComponent1->Channel[0]->Name
iComponent1->Legend[0]->Visible
iComponent1->ToolBar[0]->ShowEditButton
iComponent1->Annotation[0]->Text
iComponent1->DataCursor[0]->Style
iComponent1->Limit[0]->XAxisName
iComponent1->Labels[0]->Caption
=
=
=
=
=
=
=
=
=
=
TRUE;
100;
100;
"Channel 1";
TRUE;
FALSE;
"Sample Annotation";
ipcsDeltaX;
"X-Axis 1";
"Chart Y vs. Time";
Delphi/Kylix
iComponent1.DataView[0].GridShow
iComponent1.XAxis[0].Min
iComponent1.YAxis[0].Min
iComponent1.Channel[0].Name
iComponent1.Legend[0].Visible
iComponent1.ToolBar[0].ShowEditButton
iComponent1.Annotation[0].Text
iComponent1.DataCursor[0].Style
iComponent1.Limit[0].XAxisName
iComponent1.Labels[0].Caption
!
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
TRUE;
100;
100;
'Channel 1';
TRUE;
FALSE;
'Sample Annotation';
ipcsDeltaX;
'X-Axis 1';
"Chart Y vs. Time";
The index values are all zero based, meaning the first object’s index is 0, the second is 1,
the third is 2, and so on. Currently only one Data View, one Legend, and one Toolbar
object is supported at this time and is left open for future expansion. The Axes object is
not accessed directly. Access the X-Axis and Y-Axis objects through the individual XAxis and Y-Axis objects.
Plot Objects
As shown above, the plot component is made up of many sub objects, referred to in this manual
as plot objects. Plot Objects allow for the multiple axis, multiple channel, multiple limit,
multiple label, and multiple data cursor features of the component by allowing an unlimited
number of plot objects. Note that some plot objects currently only support one object of their
type, such as the DataView, Legend, and Toolbar, but will be upgraded in the future.
Plot Object Index
To access a specific plot object, such as the third channel for example, you need to use the index
of that plot object. Note that a plot object indices start at 0…
iComponent1.Channel(2).Property = Value
iComponent1.Channel(2).Procedure
13
Plot Object Name
All plot objects have a unique index value that is generated when they are created. You can also
associate a name to a plot object using the Name starting property of each plot object.
Each plot object is generally referenced by its index, but you can also use the name of a plot
object when referencing. This allows you to use your own system of referencing multiple
channels or axes without using the index values. Also, some properties used by other plot
objects to reference other plot objects require the name of the plot object instead of the index.
iComponent1.Channel(0).Procedure
iComponent1.Channel(iComponent1.GetChannelIndexByName("Channel 1").Procedure
iComponent1.DataCursor(1).ChannelName = "Channel 1"
iComponent1.DataCursor(1).ChannelName = iComponent1.Channel(0).Name
Get Plot Object Index By Name
You can retrieve the index of a channel or axis by using the following procedure and passing the
name of the object…
Index = iComponent1.GetChannelIndexByName("Channel 1")
Index = iComponent1.GetXAxisIndexByName("XAxis 1")
Index = iComponent1.GetYAxisIndexByName("YAxis 1")
Get Plot Object Name by Index
You can retrieve the name of any plot object as follows…
NameString
NameString
NameString
NameString
NameString
NameString
14
=
=
=
=
=
=
iComponent1.Channel(Index).Name
iComponent1.XAxis(Index).Name
iComponent1.YAxis(Index).Name
iComponent1.DataCursor(Index).Name
iComponent1.Limit(Index).Name
iComponent1.Labels(Index).Name
Chapter 4 - Axes
Chapter 4 - Axes
The Axes Plot Object refers to both the X-Axis and Y-Axes Plot Objects. You need to have at least one
X-Axis and one Y-Axis to be able to display data in the chart. Every channel that contains data will
need to be associated with one X-Axis and one Y-Axis to be able to display data.
Many of the operations of a chart are handled through the axes. The axis object not only provides a
visual display of the X-Axis and Y-Axis scales, but are dynamic in that they allow the user to scroll the
plot data that is displayed, zoom in and out, and otherwise have complete control over the data displayed
in the chart even while you are adding data in real-time! The Axes also have built-in scrolling and
scaling capabilities that make implementing a very professional chart very easy. This automated
scrolling and scaling is referred to as “Tracking”, and is fully automated. Refer to the chapter entitled
“Tracking” for more information on fine-tuning and configuring the tracking features.
Axis Objects
To move, resize, and stack axes and other plot objects show above, refer to the chapter
entitled “Visual Layout Manager” for more information about using the Visual Layout
Manager. If you need to dynamically modify the chart layout at runtime or through
your program code, refer to the chapter entitled “Layout Control Through Code”
15
Chapter 4 - Axes
As you will notice above, there is one X-Axis and actually two Y-Axis. This is useful if you have
several data channels where you would like to have a shared, common X-Axis but want to have
separate, independent Y-Axis with different scales. The above examples show the Y-Axes stacked.
You can also have them oriented side by side if you wish.
Both the X-Axis and Y-Axis objects support multiple axes, so you can have as many Y-Axes of each
type as you wish. Each channel, however, can only be associated with one X and one Y-Axis at any one
time.
Below you will find explanations of some of the features supported by both the X and Y-Axes…
Span
To set the breadth of values that are displayed on the axis, set the Span property. The Span
property specifies the value displayed between the min and maximum values of the axis. For
example, if you wish the axis to display 1000 units of data, set the Span property to 1000. If the
user scrolls the axis, they are modifying the Min property of the scale, but the span will always
be constant. If the user zooms the axis, then the Span value will change according to the
ZoomFactor. (i.e. if the user zooms in by a factor of 2, then the Span will be reduced in half
from 1000 to 500)
iPlot1.YAxis(0).Span = 1000
iPlot1.YAxis(0).Span = 1000
Min and Max
The Min property is used to set the minimum value of the axis that is currently visible. The Max
property is read only and is simply a calculation of Max = Min + Span.
iPlot1.Min = 10
'Max is a read-only value
MaxValue = iPlot1.Max
...is the same as...
MaxValue = iPlot1.YAxis(0).Min + iPlot1.YAxis(0).Span
The minimum and maximum values that the axes support are as follows...
Maximum Value: +1x10300 or +1E300
Minimum Value: -1x10300 or -1E300
Data Precision: 15 places
16
Chapter 4 - Axes
Rotated Axes
The X and Y-Axes can be rotated so that you can plot both horizontally and vertically based
upon your application needs. Refer to the Visual Layout Manager chapter for more information
or use the XYAxesReverse property from the main plot component interface.
iPlot1.XYAxesReverse = True
You can easily rotate the X and Y-Axes without using code in your
application by using the Visual Layout Manager inside of our custom
property editor. Refer to the chapter “Visual Layout Manager” for more
information on using the Visual Layout Manager.
Label Formats
All Axes support the following label format styles..
Simple Values
198678.567
2578
Exponential Values
2.35E+002
245.34564E-128
Prefix Values
2.2K
3.4M
Date/Time Values
3 Jan 01 5:23pm
01/31/2001
Price32nds
100.231
Price32nds is for use in the Bond and Securities Market. The value is
displayed where 23 is in 32nds and 1 is in 256ths. Therefore, in decimal
the price above is: 100 +23/32 + 1/256 = 100.72265625.
Pass the actual double value of 100.72265625 to display it as Price32nds
format as 100 231 to your application end user
17
Chapter 4 - Axes
Reverse Scales
All Axes can be reversed. By default, the axes increase in value from left to right or bottom to
top. This can be reversed by setting a simple property called ReverseScale.
iPlot1.XAxis(0).ReverseScale = TRUE
Log Scale
Reversed
Scale Types
All Axes support the following scale types…
Linear
This is the standard type of scale that most programmers will use in their charts. Scales
can range from values between –1x10300 to 1x10300
Logarithmic Base 10
Supports logarithmic base-10 type data. Scales can range from base-10 log values of
1x10-300 to 1x10300.
18
Chapter 4 - Axes
LabelSeparation
Use LabelSeparation to get or set the minimum separation between scale labels. LabelSeparation
represents the percentage of a character size and is based on the LabelsFont used for the axis. A
value of 0.5 is equal to half the size of a character. The actual separation maybe greater due to the
AutoScale reducing the number of major ticks to keep the scale labels in a human readable format
(1-2-5 Rule).
iPlot1.XAxis(0).LabelSeparation = 2
iPlot1.YAxis(0).LabelSeparation = 2
LabelSeparation
LabelSeparation
LabelsMargin
Use LabelsMargin to get or set the spacing between the major tick and major tick labels.
LabelsMargin represents the percentage of a character size and is based on the LabelsFont used for
the axis. A value of 0.5 is equal to half the size of a character.
iPlot1.XAxis(0).LabelsMargin = 0.25
iPlot1.YAxis(0).LabelsMargin = 0.25
LabelsMargin
19
Chapter 4 - Axes
LabelsMinLength
Use LabelsMinLength to get or set the minimum label length used in calculating the number of
scale labels (Major Ticks) during AutoScale for horizontal layout objects.
For vertical layout objects, this is used in calculating the minimum width of the layout object. Set
this value larger to ensure that the vertical layout object is of a minimum width to accommodate
larger values without needing to increase in size.
This property prevents common “oscillations” that occur when the scale flips between, for example,
4 digits at the top of the scale to three digits. To prevent oscillations in this example, set the min
length to 4 so that when the top of the scale goes down to three digits, the width is kept at four digits.
AutoScale automatically calculates the number of scale labels based on the LabelsFont,
LabelSeparation, and LabelsMinLength properties to ensure labels that are in a human readable
format (1-2-5 Rule).
iPlot1.XAxis(0).LabelsMinLength = 5
iPlot1.YAxis(0).LabelsMinLength = 10
LabelsMinLength
LabelsMinLength
!
20
All margins use units of characters. This allows the component to dynamically
adjust the scales based upon the font used instead of using rigid pixel
specifications. A value of 0.25 would be equivalent to ¼ the size (width or
height, depending on if the margin relates to a horizontal or vertical margin) of a
single character from the font being used in the layout object.
Chapter 4 - Axes
LabelsMinLengthAutoAdjust
Use LabelsMinLengthAutoAdjust to specify whether the LabelsMinLength property is
automatically adjusted as the minimum required label length increases.
While plotting, or user scrolling/zooming, the actual minimum label length may become greater than
the LabelsMinLength property value. This will result it the axis growing in size to accommodate
the wider label. If the plotting data or user changes the displayed data causing the label width to
vary, it may cause an annoying oscillation of the display plot objects sizes. To prevent this
oscillation, set this property to TRUE.
The LabelsMinLength property is stored when the TrackingEnabled property is set to FALSE.
The LabelsMinLength property will be restored to the previous value when TrackingEnabled
property is set back to TRUE.
iPlot1.XAxis(0).LabelsMinLengthAutoAdjust = True
StackingEndsMargin
Use StackingEndsMargin to get or set the margin at the end of the axis when stacked.
StackingEndsMargin represents the percentage of a character size and is based on the LabelFont
used for the axis. A value of 0.5 is equal to half the size of a character.
Note that this feature currently only supports the Axes layout objects. Also note that the stacking
margin only applies to layout objects that touch each other and only affects the ends that touch.
In the following example, the first Y-Axis (on the bottom) has a starting percent of 0 and ending
percent of 50. The second Y-Axis (on top) has a starting percent of 50 and an ending percent of 100.
The Stacking Ends Margin allocates additional space to separate the two stacked axes. The total
spacing is 0.5 characters in this example, with the StackingEndsMargin values being cumulative.
The StackingEndsMargin will have no effect on the ends of the ends of the axes unless they touch
another axis.
iPlot1.YAxis(0).StartPercent
iPlot1.YAxis(0).StopPercent
iPlot1.YAxis(0).StackingEndsMargin
= 0
= 50
= 0.25
= 50
= 100
= 0.25
21
Chapter 4 - Axes
StackingEndsMargin
(0.5 Total = 0.25 + 0.25)
Tracking
Tracking refers to the Auto-Scale and Auto-Scroll features of the axes. The axes have the
capability to adjust their scales and scroll dynamically at runtime according to several properties
that you setup. This makes it easy to implement a chart that looks and functions the way that you
would like without complex coding on your part. Refer to the chapter on Tracking for more
detailed information.
User Interface
By default, the component is setup to allow scrolling and zooming of the axes by your
application user. The application user is also able to edit the axis properties either through a
popup menu or through the run-time menu button on the toolbar. You can control the user
interface by using the Enabled and PopupEnabled properties of the axes to control whether the
user can scroll/zoom or be able to bring up the popup menu for the axis to edit properties of that
axis.
If you are using stacked axes, you may notice that the grid appears to be
drawn funny in the DataView area. To fix this, assign the grid to the
special value “<All>” so that major ticks for all axes are used to draw
the grid lines.
e.g.
iComponent.DataView(0).GridYAxisName = “<All>”
22
Chapter 4 - Axes
Customizing Tick Labels
The X and Y Axis scales are automatically configured for you using the AutoScale and
AutoLabel (1-2-5 Rule) features of the Plot Components. However, you may wish to customize
all or some of the displayed labels with your own text.
For example, let's replace all of the X-Axis labels with their string equivalents. We will use the
OnXAxisCustomizeLabel event. This event will fire each time a label above is painted on the XAxi, passing the Index of the Axis being painted, the current Value of the label being painted in
double format, and a pointer to the actual Label in String format. We will modify the Label
variable which will then be displayed in place of the original value.
Here is the chart before using the event. We have six labels, one through ten...
Visual Basic Example
Private Sub iPlotX1_OnXAxisCustomizeLabel(ByVal Index As Long, ByVal Value
As Double, ALabel As String)
'Examine the Value passed in the event. This event will fire for each
'label in the Axis (Index of the Axis is passed in the Index parameter),
'passing the Value of the Label in the Value parameter. Modify the
'ALabel string that is passed to change the label to any desired string.
Select Case Value
Case 0: ALabel = "Zero"
Case 2: ALabel = "Two"
Case 4: ALabel = "Four"
Case 6: ALabel = "Six"
Case 8: ALabel = "Eight"
Case 10: ALabel = "Ten"
End Select
End Sub
23
Chapter 4 - Axes
Visual C++ Example
void CPlotcustomizelabeltestDlg::OnXAxisCustomizeLabel_m_iPlotX1(long Index,
double Value, BSTR FAR* ALabel)
{
//Examine the Value passed in the event. This event will fire for each
//label in the Axis (Index of the Axis is passed in the Index parameter),
//passing the Value of the Label in the Value parameter. Modify the
//ALabel string that is passed to change the label to any desired string.
if (Value == 0) { *ALabel = ::SysAllocString(L"Zero"); };
if (Value == 2) { *ALabel = ::SysAllocString(L"Two"); };
if (Value == 4) { *ALabel = ::SysAllocString(L"Four"); };
if (Value == 6) { *ALabel = ::SysAllocString(L"Six"); };
if (Value == 8) { *ALabel = ::SysAllocString(L"Eight"); };
if (Value == 10) { *ALabel = ::SysAllocString(L"Ten"); };
}
Here is the chart after using the OnXAxisCustomizeLabel event...
!
24
Warning! Many development languages do not support Case
statements even evaluating Double values. The example above uses a
Case Statement for simplicity only. If you are using any language
besides Visual Basic you will need to use IF statements instead
Chapter 4 - Axes
Properties
CursorPrecision
DesiredIncrement
Height
LabelSeparation
LabelsFormatStyle
LabelsMinLength
MajorLength
Min
Name
RestoreValuesOnResume
ScaleLineShow
ScrollMin
StackingEndsMargin
TitleFontColor
TitleMargin
TrackingEnabled
Visible
CursorScaler
DesiredStart
Horizontal
LabelsFontColor
LabelsMargin
LabelsPrecision
MasterUIInput
MinorCount
OuterMargin
ReverseScale
ScaleType
ScrollMinMaxEnabled
StartPercent
TitleFont
TitleShow
TrackingScrollCompressMax
Width
DateTimeFormat
Enabled
InnerMargin
LabelsFont
LabelsMinLengthAutoAdjust
LabelsPrecisionStyle
Max
MinorLength
PopupEnabled
ScaleLinesColor
ScrollMax
Span
StopPercent
Title
TrackingAlignFirstStyle
TrackingStyle
ZOrder
Refer to Appendix C and D for more detailed information about this plot object’s properties.
Methods
GetLabelText
PixelsToPosition
ResetFirstAlign
Zoom
NewTrackingData
PositionToPercent
UpdateResumeValues
PercentToPosition
PositionToPixels
ValueOnScale
Refer to Appendix C and D for more detailed information about this plot object’s methods.
Events
!
OnXAxisMinChange
OnYAxisMinChange
OnXAxisSpanChange
OnYAxisSpanChange
All events are on the main component interface and not on the sub-object interface.
25
Chapter 5 - Data View
The Data View object is the center-point of the Plot Pack components. This is the area where your data
points, trend lines, data cursors, limits, and annotations are displayed.
Currently, only one data view is available. The Data View only displays graphical representations of the
Channel data. In a future release, a grid data view object will be made available to show numerical
representations of your chart data.
Data View Object
26
Channels
The channels objects are configured by using the properties and methods of the channel object. To
add a channel, execute the AddChannel method from the main interface. To add data or to
configure a particular channel, use the index of the channel with the channel sub-interface…
Index = iComponent.AddChannel
iComponent.Channel(Index).Procedure
iComponent.Channel(Index).Property
Here are some specific examples…
iComponent.Channel(0).AddXY(12.3, 14.56432)
Value = iComponent.Channel(0).GetXMean
iComponent.Channel(0).Color = vbRed
iComponent.Channel(0).MarkersStyle = ipmsSquare
Index = iComponent.GetChannelIndexByName("Channel 1")
iComponent.Channel(Index).AddXY(12.3, 14.56432)
Value = iComponentChannel(Index).GetXMean
iComponent.Channel(Index).Color = vbRed
iComponent.Channel(Index).MarkersStyle = ipmsSquare
!
Remember that one channel is added to the component by default when it is created.
You can execute the RemoveAllChannels method in your form loading handler if
you wish to remove all channels and start with a component with no channels.
Refer to the “Channels” Chapter for more information about using the Channels Object
Annotations
Annotations are configured by using the properties and methods of the annotation object. To add
an annotation, execute the AddAnnotation method from the main interface. To configure a
particular annotation, use the index of the annotation with the annotation sub-interface…
Index = iComponent.AddAnnotation
iComponent.Annotation(Index).Procedure
iComponent.Annotation(Index).Property
iComponent.Annotation(0).ChannelName = "Channel 1"
iComponent.Annotation(0).ChannelName = iComponent.Channel(0).Name
iComponent.Annotation(0).BrushColor = vbRed
iComponent.Annotation(0).X = 12.5
iComponent.Annotation(0).Y = 37.25
iComponent.Annotation(0).TextRotation = ira180
Refer to the “Annotations” Chapter for more information about using the Annotation Object
27
Data Cursors
Data are configured by using the properties and methods of the DataCursor object. To add a data
cursor, execute the AddDataCursor method from the main interface. To configure a particular data
cursor, use the index of the data cursor with the data cursor sub-interface…
Index = iComponent.AddDataCursor
iComponent.DataCursor(Index).Procedure
iComponent.DataCursor(Index).Property
iComponent.DataCursor(0).ChannelName = "Channel 1"
iComponent.DataCursor(0).ChannelName = iComponent.Channel(0).Name
iComponent.DataCursor(0).HintShow = False
Value = iComponent.DataCursor(0).ValueX
Value = iComponent.DataCursor(0).ValueY
iComponent.DataCursor(0).Style = ipcsDeltaX
!
Remember that one data cursor is added to the component by default when it is created.
You can execute the RemoveAllDataCursors method in your form loading handler if you
wish to remove all data cursors and start with a component with no data cursors. Data
Cursors are initially hidden by default(i.e. their visible properties are set to False). To
show the data cursors, click on the data cursor button on the toolbar at runtime, set the
Visible property of the data cursor to True, or execute the DoButtonClickCursor
procedure from the toolbar object.
Refer to the “Data Cursors” Chapter for more information about using the Cursors Object
Limits
Limits configured by using the properties and methods of the limit object. To add a limit, execute
the AddLimit method from the main interface. To configure a particular limit, use the index of the
limit with the annotation sub-interface…
Index = iComponent.AddLimit
iComponent.Limit(Index).Procedure
iComponent.Limit(Index).Property
iComponent.Limit(0).XAxisName = "XAxis 1"
iComponent.Limit(0).YAxisName = "YAxis 1"
iComponent.Limit(0).XAxisName = iComponent.XAxis(0).Name
iComponent.Limit(0).YAxisName = iComponent.YAxis(0).Name
iComponent.Limit(0).Line1Position = 25.0
iComponent.Limit(0).Line2Position = 37.2
iComponent.Limit(0).Style = iplsBandX
Refer to the “Limits” Chapter for more information about using the Limits Object
28
Layer Order
Objects in the Data View area, such as the grid, channels, limits, annotations, and data cursors
are draw in the following order from bottom to top…
•
•
•
•
•
Grid
Channels
Limits
Annotations
Data Cursors
In a future release, the ability to change the layer order of the objects in the Data View area will
be made available. Access to objects in the Data View area is obtained through the Channel,
Annotation, and Limit objects, as the DataView object is just a container for these objects.
Grids
The grid lines you see beneath your plotted data in the DataView area can be configured by
using the properties listed below or by using the built-in property editor. The grid lines are
drawn with respect to a specified set of X and Y-Axis Major and Minor tick marks as well as
around the DataView area. You can setup the grid lines to be drawn to any, all, or none of these
lines as you desire.
Grid Lines
29
Major and Minor Lines
The GridLineShowXMajors and GridLineShowYMajors properties control whether a line is
drawn with respect to the X and Y Major tick marks on your axis. The drawn lines will scroll
with the axis when it is scrolled either by the application user or by the AutoScroll capability of
the chart.
Similarly, the GridLineShowXMinors and GridLineShowYMinors properties control whether
a line is drawn with respect to the X and Y Minor tick marks on your axis.
Major Tick
Grid Line
Minor Tick
Grid Line
If you need to draw grid lines that match up with all Axes or that scroll
independently with their associated Axes, utilize the special “<All>” axis which
will instruct the grid lines to be drawn for all visible Axes of that type. For
example, if you are stacking three Y-Axes, you will probably want the horizontal
grid lines to match up with the major ticks of each axis. To do this, simply set the
GridYAxisName property of the DataView object to “<All>”.
iComponent.DataView(0).GridXAxisName = "<All>"
iComponent.DataView(0).GridYAxisName = "<All>"
30
Stacked Axes and Grid Lines
When you use stacked axes in the plot components, the standard setting of one Y-Axis or X-Axis
to draw the grid lines doesn’t always look correct. For example, the following grid lines do not
work for this stacked-axes chart…
Grid Lines Drawn to Only One Y-Axis
31
The chart would look better if the Y-Axis grid lines were drawn to the ticks of all Y-Axis. To fix
this, simply set the GridYAxisName property to the special value of “<All>”…
iPlot1.DataView(0).GridYAxisName = "<All>"
The resulting chart would look like the following…
Grid Lines Drawn to All Y-Axes
32
Properties
BackgroundColor
GridLineColor
GridLineShowBottom
GridLineShowTop
GridLineShowYMajors
GridXAxisName
Horizontal
StartPercent
Visible
BackgroundTranparent
GridLineMajorStyle
GridLineShowLeft
GridLineShowXMajors
GridLineShowYMinors
GridYAxisName
Name
StopPercent
Width
Enabled
GridLineMinorStyle
GridLineShowRight
GridLineShowXMinors
GridShow
Height
PopupEnabled
Title
ZOrder
Methods
None. Open for future expansion.
Events
33
Chapter 6 - Channels
The Channel objects are the Plot Component objects that contain your Chart Data (Data Points) and
provide the interface for adding data and sending tracking data to the associated axes.
There can be an unlimited number of channels in your chart. Each is addressed differently and
independent of all of the other channels in the chart. Each channel is associated with a particular X and
Y-Axis so that it may draw its data in the Data View in relation to the X and Y Scales.
Each channel can have an associated channel data trace line that connects individual data points, channel
data marker to show individual data points, and data fill (iPlot component only) to flood fill a color or
pattern to a reference line. Channels can be synchronous or asynchronous, depending on your needs.
Display of digital data is also supported.
Channel Object
If you open the run-time property editor and navigate to the channel’s tab,
you will be able to access the Stats page which gives you current Point
Count, Memory, and other important statistics about the selected channel.
34
Trace Lines
Trace Lines are the lines drawn between data points on the graph. You can specify the line’s
color, width, and style to help differentiate it from other trace lines in your chart. For graphs that
don’t require lines drawn between data points, you can turn off the trace line by setting the
TraceVisible property to False.
Curve fitting or Interpolation (e.g. Straight Line, Cubic Spline, Polynomial, Rational,
Differential, etc) is also supported by the iPlot component channel object in addition to
straight trace lines
.
Refer to the chapter entitled “Interpolation” for more information.
The following line styles are available…
Style
iplsSolid
iplsDash
iplsDot
iplsDashDot
iplsDashDotDot
Description
A solid line.
A line made up of a series of dashes.
A line made up of a series of dots.
A line made up of alternating dashes and dots.
A line made up of a serious of dash-dot-dot combinations.
Since we use the Windows API (ActiveX and VCL components), trace line styles such
as dashed, dot, and dot dash styles do not work with line widths greater than 1 (i.e. with
line widths greater than 1, the trace line will always be solid.). Adding the ability to
draw line widths greater than 1 using non-solid lines would seriously affect the speed
of the component, so it is recommended that the data point markers and channel colors
be used to differentiate between channels with line widths greater than 1.
35
Data Markers
By default, when a data point is drawn on the plot component DataView area, a single-pixel
point is used. You can, however, use larger symbols or markers to denote a data point on the
chart. This is useful in differentiating between channel data points and for highlighting true data
points.
The following types of markers are available. Additional types will be added as needed and is
open for future expansion.
Style
ipmsCircle
ipmsSquare
ipmsDiamond
ipmsCross
ipmsPlus
ipmsTriangleUp
ipmsTriangleDown
ipmsTriangleLeft
ipmsTriangleRight
Description
Circle
Square
Diamond
Cross
Plus
Triangle Pointing Up
Triangle Pointing Down
Triangle Pointing Left
Triangle Pointing Right
Individual Data Markers
By default, when data markers are drawn, the same data marker is used for all data points. You
can specify different Data Markers for individual points. When the Data Marker is initially
added to the channel, its properties are initially set to the default values specified for the channel.
First, set the MarkersAllowIndividual property to True to allow individual specification of each
data marker. You can then later use the following properties to modify a data marker.
'Setup Channel
iPlot1.Channel(0).MarkersVisible = True
iPlot1.Channel(0).MarkersStyle = ipmsDiamond 'The default style for all
'data markers
iPlot1.Channel(0).MarkersAllowIndividual = True
'Data Point 1
index = iPlot1.Channel(0).AddXY (10, 75) 'We'll let this data marker
'use the default values
'Data Point 2
index = iPlot1.Channel(0).AddXY (10, 75)
iPlot1.Channel(0).DataMarkerShow(Index) = False 'Hide this specific
'data marker
'Data Point 3
index = iPlot1.Channel(0).AddXY (11, 72)
iPlot1.Channel(0).DataMarkerStyle(index) = ipmsPlus 'Change the style
'of this data marker
36
Channel Fill
The iPlot component supports the ability to flood fill an area between the trace line and a
specified base line (either above or below the trace line). The Fill feature is not available with
the iXYPlot component since its datasets are not based on y = f(x) .
To specify a baseline for the flood fill, use the FillReference property on a specific channel.
ReferenceLine = 80
ReferenceLine = 60
ReferenceLine = 0
Tracking
Tracking refers to the AutoScale and AutoScrolling features of the axes. When new data is
added to the channel, tracking data is sent to the associated X and Y-Axes for the channel
regarding the newly added data. This data is used by the chart to automatically scale and scroll
the axes and channel data.
By default, tracking data is sent to both the X and Y-Axes referred to by the channel’s
XAxisName and YAxisName properties. You can enable or disable the sending of tracking data
to a specific X or Y-Axis by using the XAxisTrackingEnabled and YAxisTrackingEnabled
properties.
37
Ring Buffer
By default, the chart will buffer all of the data points added to all channels into RAM. This
buffered data makes it possible to scroll back to older data (history) and other related functions.
The RingBuffer property allows you to control how much data is stored in available memory. If
you set the RingBuffer property to 10,000, then memory will be allocated for 10,000 data
points. After you add 10,000 data points, the oldest data will begin to be replaced by newly
added data points. The Ring Buffer is a FIFO (First In First Out) type buffer. You can find
more information on using the Ring Buffer feature in the chapter entitled “Memory Utilization”.
Remember that the RingBuffer properties are assigned to individual channels,
and are independent of other channels.
Also, Remember that the RingBuffer is specified as the number of data points
that will be stored in the buffer.
Digital Channel Support
If your data sets contain binary data (0’s and 1’s, True and False, etc.), then you can set the
DigitalEnabled property to True to enable Digital Channel support.
When Digital Channel Support is on, Y values that are = 0 are plotted on the Y-Axis scale
according to the DigitalReferenceLow value. Y values that are < 0 or > 0 are plotted on the YAxis scale according to the DigitalReferenceHigh value. The result is two possible values for Y
on the Y-Axis.
!
Some compilers treat True as –1 or 1, so any value that is not 0 is treated as a
Digital High or Logic = True .
All data will be squared off, with a horizontal line drawn from the last data point to the next data
point, and then a vertical line drawn between the last horizontal line to the next data point as
shown below in Channel #2…
38
Data Points
Asynchronous and Synchronous Data
The Plot Components are able to handle Asynchronous Data (several channels that don’t have
synchronized X-Axis or Time data values) or Synchronous Data (several channels that have XAxis or Time data values that are the same. i.e. there is one data point in each channel for any
given X-Axis or Time data value).
The only difference between the two data set types relates to the use of the following features of
the chart…
•
Using the AddDataArray method: This method allows you to add data to all channels
by passing the channel data as an array to the main plot interface instead of individually
to each channel. This method requires that your data be synchronous.
If you data is asynchronous, you can add data using the AddDataArray method by using
two special data point values for those data points which don’t exist for a particular
channel or for those data points which are null values…
Set the data value to 5E-301 for Null Value Data Points
Set the data value to 5E-302 for Empty Value Data Points
39
•
Using the Channel Data Logging feature off of the main plot interface instead of
individually from each channel: If you are using asynchronous data in conjunction with
the AddDataArray method, then you must ensure that the LogBufferSize property is set
to 0 or 1 to disable caching of data before it is written to the log file from the main
interface. If you data is synchronous, then the LogBufferSize can be set to any value you
wish to use.
Channel Data Logging
This feature is useful if you need an automated way of saving chart data to disk as it is being
added in real-time. The saved data can be used by an external program or can be used to reload
the data back into the chart at a later time.
Channel Data Logging can be setup for each individual channel. You can also setup the main
interface for automatic Channel Data Logging of all channels to disk, but you must be using
Synchronous Data.
Refer to the chapter entitled “Loading and Saving Data” for more detailed information.
!
The directory specified when using the channel data logging feature must exist
on the target system and the application’s user must have permissions to write to
that directory or file. Otherwise, an exception error will be generated.
FastDraw
Quick Description: This feature, only available with the iPlot component, increases the drawing
efficiency of the channel data when drawing large data sets to the Data View area. This is
accomplished by reducing the number of drawing operations required to draw your channel data.
•
Benefits: Dramatically speeds up drawing of data points and trace lines to the screen when you are
showing a large number of data points.
•
Drawbacks: Can create aliasing effects if you are using the smooth-scrolling features of the
component. However, it is guaranteed to show you the extremes of the data points at all times.
40
Technical Description: when this feature is turned on, the iPlot component reduces the number
of repaints to the screen by only drawing the data points that would be visible on the video
screen. It does this by determining how many data points would be drawn in any one video
screen pixel, and then representing all of those data points as a single data point.
The following shows how the number of data points and trace lines are reduced during the
painting process of channel data when utilizing the FastDraw feature of the component.The first
grid (each square is a pixel) shows the data points and trace lines as they would be drawn if
FastDraw was disabled…
Each line segment represents a drawing operation. Each dot represents a data point in the
channel object. Counting the number of line segments and data markers results in 15 drawing
operations.
This is what the screen would actually look like, remembering that each square is a pixel…
41
Now, lets try to reduce the number of drawing operations in the third column. In the third
column (shaded in yellow for emphasis), we have four data points and three line segments.
Since the line segments are simply overlapping each other, we can reduce the number of line
draws by performing the following method…
1. Determine the first and last data point in the column of data points (P3 and P4).
2. Determine the maximum and minimum Y values in the column of data points (Represented
by diamond-shaped points).
3. Do not draw the data markers between the first and last data points in the column
(Represented by gray-data points)
4. Connect a line between the previous data point in the previous column(P2) to the first data
point(P3).
5. Connect a line between the next data point in the next column (P5) to the last data point(P4).
6. Draw a perpendicular line between the Y maximum and Y minimum values.
P2
P4
P5
P6
P1
P3
Again, counting the number of line segments drawn and data markers drawn results in 11
drawing operations. This results in a reduction of 4 drawing operations when compared to not
using FastDraw. The greater the number of data points that fit in a single column of pixels, the
more FastDraw can reduce the number of drawing operations, resulting in faster redraws and
overall speed of the component.
To sum up FastDraw, if we assume that the data points are equally spaced across the DataView
area, turning on FastDraw will reduce the number of drawing operations when there are more
than two data points per column of pixels in the Data View. In other words, the following
formula must be satisfied…
((Number of Visible Data Points) / (DataView Width in Pixels)) > 2
If the number of data points is not equally spaced across the DataView, FastDraw will speed up
the drawing of the component when more than two data points occupy the same column of pixels
in the DataView area.
42
Channel Types
Each component in the Plot Pack is setup to handle a specific plotting task using a channel type
specific to that plot component. The channel type denotes which features are available for
adding data to that channel. The channel types available for use are as follows.
Refer to the chapter entitled “Adding Data” for more detailed information on using the different
add data methods described below.
iPlot Component Channel: iPlotChannel:
This is the channel type used by the iPlot component. Implements Date Time adding methods
and method for adding X Null data points. For Date Time adding methods, it is assumed that the
X-Axis is the Time Axis. You can rotate the axes if you wish the Time Axis (the X-Axis) to be
vertical instead of horizontal.
•
AddXY : adds data points in X and Y data point pairs.
Index = iPlot1.Channel(ChannelNumber).AddXY(XValue, YValue)
Index = iPlot1.Channel(0).AddXY(10.34, 25.43)
•
AddXYArrays : adds data points from two variant arrays, each containing x and y
values. The number of elements in each array must be identical (i.e. if XData contains
100 elements, YData must contain 100 elements), otherwise an exception will be
generated.
Index = iPlot1.Channel(ChannelNumber).AddXYArrays(XArray, YArray)
This procedure is able to handle variant arrays that start at element 0 or any value that
you require. If you array starts at element XData(10), then that value will be used to add
the first data point.
It is recommended that you loop through your array and use the AddXY method to
add data to the chart as that is much faster than using the AddXYArrays procedure
due to the use of Variants. This procedure has been added as a convenient way of
passing variant arrays to the channel to add data, but is slower than simply looping
through the array in your program. If your data is already in Variant array format
(i.e. not a double array), then there is no performance penalty by using the
AddXYArrays procedure.
•
AddYArray : Adds multiple y values with a specified X-Axis spacing interval. For
example, if your variant array (Y values) contains 100 elements and your XInterval is 1,
then the plot component will plot all of your Y values with an increasing X value of 1.
First data point is (1, YData(0)), second data point is (2,YData(1)), third data point is
(3,YData(2)), fourth data point is (4, YData(3)), etc.
Index = iPlot1.Channel(ChannelNumber).AddYArray(XInterval, YArray)
43
The interval depends on whether your X-Axis is in Date/Time format or not. If
LabelsFormatStyle of the X-Axis is iptfDateTime, then the interval must be
specified in Date/Time format. Otherwise, the interval is expressed in seconds or
the units that are used on your X-Axis.
•
AddYElapsedSeconds : adds a Y data point at an X coordinate specified by the number
of elapsed seconds since the ResetElapsedStartTime method was called.
Index = iPlot1.Channel(0).AddYElapsedSeconds(YValue)
Index = iPlot1.Channel(0).AddYElapsedSeconds(25.43)
•
AddYElapsedTime : adds a Y data point at an X coordinate specified by the amount of
time (in DateTimeFormat) since the ResetElapsedStartTime method was called.
Index = iPlot1.Channel(0).AddYElapsedTime(YValue)
Index = iPlot1.Channel(0).AddYElapsedTime(25.43)
•
AddYNow : adds a Y data point at an X coordinate specified by the current system time
(in DateTimeFormat).
Index = iPlot1.Channel(0).AddYNow(YValue)
Index = iPlot1.Channel(0).AddYNow(25.43)
•
AddXNull : adds a data point at a specified X data point. The Y value will be set to Null.
Index = iPlot1.Channel(0).AddXNull(XValue)
Index = iPlot1.Channel(0).AddXNull(10.34)
•
AddXEmpty : adds an empty data point at a specified X coordinate with no Y
coordinate. An empty data point is a data point with no X or Y Value, only an index
placeholder for the data point. Since this data point doesn’t have an X or Y Value, no
Data Marker is shown and the trace line will not be drawn to this data point. This is
useful for adding data point “placeholders” so that you can set the X and Y value of the
data point at a later time.
Index = iPlot1.Channel(0).AddXEmpty(XValue)
Index = iPlot1.Channel(0).AddXEmpty (10.34)
Refer to the chapter entitled “Null Data and Empty Data Handling” for more
information on Null and Empty Data Points.
!
44
The iPlot component does not support null X data points. Use the iXYPlot
component if you need to create null X and Y data points.
iXYPlot Component Channel: iPlotXYChannel:
This is the channel type used by the iXYPlot component. Supports adding data using the
AddXY method. Also supported is the AddNull method for adding null data points
•
AddXY : adds data points in X and Y data point pairs.
iPlot1.Channel(0).AddXY(XValue, YValue)
iPlot1.Channel(0).AddXY(10.34, 25.43)
•
AddXYArrays : adds data points from two variant arrays, each containing X and Y
values. The number of elements in each array must be identical (i.e. if XArray contains
100 elements, YArray must contain 100 elements), otherwise an exception will be
generated.
iPlot1.Channel(0).AddXYArrays(XArray, YArray)
•
AddNull : sets a data point as a null data point (both X and Y coordinates).
Index = iPlot1.Channel(0).AddNull()
'or you can add a point and then set it to null later
Index = iPlot1.Channel(0).AddXY(15.4,17.9)
iPlot1.Channel(0).DataNull(Index) = TRUE
•
AddEmpty : sets a data point as an empty data point. An empty data point is a data point
with no X or Y Value, only an index placeholder for the data point. Since this data point
doesn’t have an X or Y Value, no Data Marker is shown and the trace line will not be
drawn to this data point. This is useful for adding data point “placeholders” so that you
can set the X and Y value of the data point at a later time.
Index = iPlot1.Channel(0).AddEmpty()
'You can later set the X and Y
'data point by using the DataX
iPlot1.Channel(0).DataX(Index)
iPlot1.Channel(0).DataY(Index)
coordinates of this
and DataY properties
= XValue
= YValue
Refer to the chapter entitled “Null Data and Empty Data Handling” for more
information on Null and Empty Data Points.
45
Properties
Color
DataMarkerShow
DataX
DigitalReferenceHigh
ElapsedStartTime
FillColor
FillStyle
LogBufferSize
MarkersAllowIndividual
MarkersBrushUseChannelColor
MarkersPenUseChannelColor
MarkersStyle
PopupEnabled
RunningYMean
TitleText
TraceVisible
XAxisName
YAxisTrackingEnabled
Count
DataMarkerStyle
DataY
DigitalReferenceLow
Enabled
FillEnabled
FillUseChannelColor
LogFileName
MarkersBrushColor
MarkersPenColor
MarkersPenWidth
MarkersVisible
RingBufferSize
RunningYMin
TraceLineStyle
VisibleInLegend
XAxisTrackingEnabled
DataEmpty
DataNull
DigitalEnabled
DigitalReferenceStyle
FastDrawEnabled
FillReference
InterpolationStyle
LoggingActive
MarkersBrushStyle
MarkersPenStyle
MarkersSize
Name
RunningYMax
Tag
TraceLineWidth
Visible
YAxisName
Methods
AddEmpty [iXYPlot Only]
AddXYArrays
AddYElapsedSeconds [iPlot Only]
Clear
GetXMin
GetYMean
ResetElapsedStartTime
AddXEmpty [iPlot Only]
AddXY
AddYElapsedTime [iPlot Only]
GetXMax
GetYInterpolated [iPlot Only]
GetYMin
LogActivate
SaveDataToFile
AddXNull [iPlot Only]
AddYArray
AddYNow [iPlot Only]
GetXMean
GetYMax
LoadDataFromFile
LogDeactivate
Events
OnClickDataPoint
!
46
Chapter 7 - Legend
Chapter 7 - Legend
The Legend object provides display of channel names and their associated line and marker color
symbols for easy reference by your application user.
Legend Object
!
Currently, the legend can only be vertical. Horizontal support will be added in a
future release.
47
Chapter 7 - Legend
Predefined Columns
By default, only the “Line” column is shown in the legend as well as the Channel Title. You can
choose to show or hide the following columns in the chart as well as their associated titles…
•
•
•
•
•
•
•
•
•
Line : Displays the line style and line color of the channel.
Marker : Displays the marker style and marker color of the channel.
X-Axis Title : Displays the X-Axis title associated with this channel.
Y-Axis Title : Displays the Y-Axis title associated with this channel.
X-Value: Displays the last added data point’s X-Value for this channel.
Y-Value: Displays the last added data point’s Y-Value for this channel.
Y-Max: Displays the maximum Y-Value for this channel.
Y-Min: Displays the minimum Y-Value for this channel.
Y-Mean: Displays the mean Y-Value for this channel.
If you are using long Titles for your channels, you can utilize the
ChannelNameMaxWidth property. This property specifies the maximum width, in
characters, of Titles displayed in the legend. If the Title exceeds the number of
characters specified, it will word-wrap to the next line.
!
48
Only the Channel Title is shown in the “Title” Column. The Channel Title is set by
using the ChannelTitle property of the channel. The Name property of each channel
is the name that is used programmatically and is not the title seen by end user of the
chart.
Chapter 7 - Legend
Turn On and Off Column Titles
By default, the title of each column in the legend is not shown. You can choose to show the title
of each column by setting the ColumnTitlesVisible = True or by using the built-in property
editor to make the Column Titles Visible.
Properties
BackGroundColor
ColumnSpacing
ColumnTitlesVisible
Font
MarginBottom
MarginTop
RowSpacing
SelectedItemFont
ShowColumnXAxisTitle
ShowColumnYMax
ShowColumnYValue
Visible
BackGroundTransparent
ColumnTitlesFontColor
Enabled
Height
MarginLeft
Name
SelectedItemBackGroundColor
ShowColumnLine
ShowColumnXValue
ShowColumnYMean
StartPercent
Width
ChannelNameMaxWidth
ColumnTitlesFont
FontColor
Horizontal
MarginRight
PopupEnabled
SelectedItemFontColor
ShowColumnMarker
ShowColumnYAxisTitle
ShowColumnYMin
StopPercent
ZOrder
Methods
Events
!
If you change previous data points, the YMax, YMin, and YMean values will
no longer be valid. To refresh these values if you change previous data
points, call GetYMax, GetYMin, and/or GetYMean to force a recalculation
of these values after making your chages.
In versions prior to Version 2.0.4 Service Pack 2, the X-Value and Y-Value
columns were used to display the current position of the cursor. This has
been changed so that cursor position data is shown in a hint window next to
the cursor line(s). Refer to the chapter on Cursors for more information
about displaying cursor data.
49
Chapter 8 - ToolBar
Chapter 8 - ToolBar
The ToolBar object provides access for your application user to many built-in features of the Plot Pack
components such as Tracking Control, Zooming, Scrolling, Cursor, Clipboard, Print, Save, access to the
Run-Time Property Editor, and many other functions which can be expanded.
The built-in toolbar makes it easy to use our component without needing a separate, external component
or additional program code to implement a toolbar. Of course, if you need additional features that our
toolbar doesn’t provide or if you need to include functions in a unified application toolbar, you can
dispense with this toolbar and implement a toolbar externally. Refer to the chapter entitled
“Implementing Toolbar Externally” for more detailed information.
Currently, the toolbar only supports being aligned to the top of the component. Moving and sizing the
toolbar as well as support for multiple toolbars is left open for future expansion.
ToolBar Object
50
Chapter 8 - ToolBar
Configure Individual Buttons
There are currently 10 buttons available for display and use in the toolbar. You can individually
show or hide buttons by using the “Show” properties listed below. Additional buttons will be
added and is open for future expansion.
Implemented Externally
There are various methods and properties implemented for use in your programs code to control
the toolbar outside of the Plot Component. Refer to the chapter on “Implementing ToolBar
Externally” for more information.
Button Descriptions
Resume Button
This button resumes all tracking on all axes. Also, all cursors are
hidden and all axes are re-zoomed to their stored values. To ensure that
new axis zoom settings are saved, right-click on the appropriate axis and
select "Update Resume Values".
Pause Button
This button pauses tracking on all axes.
Axes Scroll Mode Button
There are two modes available when clicking the mouse on an axis and
moving the mouse up/down or right/left. This button allows the axis to
scroll.
Axes Zoom Mode Button
There are two modes available when clicking the mouse on an axis and
moving the mouse up/down or right/left. This button allows the axis to
zoom.
51
Chapter 8 - ToolBar
Zoom In Button
This button increases the zoom on all axes by a factor 2x.
Zoom Out Button
This button decreases the zoom on all axes by a factor 2x.
Select Button
Used for selecting items in the data view area. Generates events that can
be used by the programmer to react to selection of items such as data
points, annotations, areas of the data view, etc. Also used for moving
annotations that have their UserCanMove property set to TRUE.
Zoom Box Button
This button allows the user to draw a box on the DataView area and zoom
all axes around the selected area.
Cursor Button
This button shows or hides all data cursors.
Edit Button
This button brings up the run-time property editor for the component.
Copy Button
This button copies an Enhanced Metafile Format version of the component to
the clipboard.
52
Chapter 8 - ToolBar
Save Button
This button brings up a save dialog to save out snapshots of the chart in
several supported graphic formats.
Print Button
This button brings up a print selection dialog to print out the current
chart to a system or network printer. The chart as it is drawn when this
button is pressed is used to generate the chart printout.
Properties
CursorActive
Horizontal
ShowAxesModeButtons
ShowEditButton
ShowResumeButton
ShowZoomBoxButton
StopPercent
ZoomBoxActive
Enabled
Name
ShowCopyButton
ShowPauseButton
ShowSaveButton
ShowZoomInOutButtons
Visible
ZoomInOutFactor
Height
PopupEnabled
ShowCursorButton
ShowPrintButton
ShowSelectButton
StartPercent
Width
ZOrder
Methods
DoButtonClickCopy
DoButtonClickPause
DoButtonClickSave
DoButtonClickZoomAxesMode
DoButtonClickZoomOut
DoButtonClickCursor
DoButtonClickPrint
DoButtonClickScrollAxesMode
DoButtonClickZoomBox
TurnOffCursor
DoButtonClickEdit
DoButtonClickResume
DoButtonClickSelect
DoButtonClickZoomIn
Also refer to the Implementing Toolbar Externally chapter for more information.
Events
53
Chapter 9 - Annotations
The Annotation Objects are the text and shapes that can be displayed in the DataView, overlaid over
your channel data. Annotations can be positioned in relation to a particular channel or to the DataView
area, depending on whether you want the annotations to scroll or track with the channel data or be fixed
in place within the DataView.
Annotations can be in the form of text strings, lines, or rectangles. Additional annotation types will be
added and is open for future expansion.
Text Annotation Object
54
Graphical Annotation Objects
Annotation Types
Text
Text annotations. Font size, style, name, color properties, and text rotation can be set for
each individual text annotation. Use the X and Y properties to set the center-point of the
Text Object. The text will be centered both horizontally and vertically around this point.
Sample Annotation
X, Y Center Point
Line
Line annotations. Width, length, and line color properties can be set for each individual
line annotation. Use the X and Y properties to set the beginning point of the line (X,Y)
and the X2 and Y2 properties to set the end point of the line (X2, Y2).
X, Y Start Point
PenColor,
PenStyle, and
PenWidth
X2, Y2 End Point
Rectangle
Rectangle annotations. Width, length, line color, fill style, and fill color properties can be
set for each individual rectangle annotation. Use the X and Y properties to set the centerpoint of the Rectangle Object. The rectangle will be centered both horizontally and
vertically around this point. Use the Width and Height properties to set the rectangle’s
width and height. Use the PenColor, PenWidth, and PenStyle properties to set the
border line properties. Use the BrushColor and BrushStyle properties to set the fill
properties.
BrushColor and
BrushStyle
PenColor,
PenStyle, and
PenWidth
X, Y Center Point
55
LineX
X-Axis Line Annotation. Set the X coordinate to specify the X-Axis value that will be used to
draw a line perpendicular to the X-Axis. The length of the line goes from positive infinity to
negative infinity on the Y-Axis.
PenColor,
PenStyle, and
PenWidth
X-Axis Value
LineY
Y-Axis Line Annotation. Set the Y coordinate to specify the Y-Axis value that will be used to
draw a line perpendicular to the Y-Axis. The length of the line goes from positive infinity to
negative infinity on the X-Axis.
Y-Axis Value
PenColor,
PenStyle, and
PenWidth
Reversing Axes has no effect on DataView aligned Annotations. The reference
values specified are always left to right (0-100) and bottom to top in relation to
the Data View.
56
Annotation Reference Relationships
When setting the X, Y, X2, and Y2 coordinates of each annotation object, these coordinates can
refer either to a specific channel or to the DataView itself.
DataView Reference
To have the annotation be referenced to a particular channel, set the Reference property
to iprtDataView. The coordinates will now refer to the DataView and will in effect be
static in relation to the axes and channels in the chart. The range of values possible for
the X and Y coordinates are from 0 – 100. A value of 0 would correspond to the left (X
coordinate) or bottom (Y coordinate) of the DataView area. A value of 100 would
correspond to the right (X coordinate) or top (Y coordinate) of the DataView area. A
value of 50 would be halfway in-between.
Channel Reference
To have the annotation be referenced to a particular channel, set the ChannelName
Property to the name of the channel and set the Reference property to iprtChannel. The
coordinates specified will now be in reference to the X and Y-Axes associated with that
channel. In effect, the annotation will move with the channel as the channel and
associated axes are scrolled.
Reference = iprtDataView
Annotation references the Data View
Reference = iprtChannel
Annotation references the specified Channel’s Axes
57
Moveable Annotations
Annotations can be moveable by your application end user by setting the UserCanMove property
of each annotation object.
Index = iPlot1.Annotation(0).UserCanMove = True
When this property is set to true, the application end-user at runtime will be able to grab a hold
of and drag annotations within the DataView area.
How to Add Annotations
To add an annotation to the chart, simply execute the following method…
Index = iPlot1.AddAnnotation
The return value is an unique index for use in manipulating the object. After adding the object,
you can set the properties of the annotation, such as setting the object as a text annotation and its
associated font properties or setting the object as a line annotation and its associated line
properties. [Note: Font properties in the example below will differ depending on your compiler]
Text Annotation Example
iPlot1.Annotation(Index).Reference
iPlot1.Annotation(Index).ChannelName
iPlot1.Annotation(Index).X
iPlot1.Annotation(Index).Y
iPlot1.Annotation(Index).Style
iPlot1.Annotation(Index).FontColor
iPlot1.Annotation(Index).Text
iPlot1.Annotation(Index).TextRotation
=
=
=
=
=
=
=
=
iprtChannel
"Channel 1"
18.33 'Center X Coordinate
59.85 'Center Y Coordinate
ipasText 'Text Annotation
vbWhite 'White Font
"Sample Annotation"
ira180 'Rotate up-side-down
Line Annotation Example
iPlot1.Annotation(Index).X2
iPlot1.Annotation(Index).Y2
iPlot1.Annotation(Index).PenColor
iPlot1.Annotation(Index).PenStyle
iPlot1.Annotation(Index).PenWidth
58
=
=
=
=
=
=
=
=
=
=
iprtChannel
iPlot1.Channel(0).Name
18.33 'Starting X Coordinate
59.85 'Starting Y Coordinate
67.4
'Ending X Coordinate
104.85 'Ending Y Coordinate
ipasLine 'Line Annotation
vbWhite 'White Line
psSolid 'Solid Line
2
Rectangle Annotation Example
iPlot1.Annotation(Index).BrushColor
iPlot1.Annotation(Index).BrushStyle
=
=
=
=
=
=
=
=
=
iprtDataView
55.25 'Center X % Coordinate
75.25 'Center Y % Coordinate
ipasRectangle 'Rectangle Annotation
vbWhite 'White Border
psDash 'Dashed Line
1
vbYellow 'Yellow Fill
bsDiagCross
=
=
=
=
=
=
=
iprtChannel
18.33 'X Coordinate
ipasLineX 'LineX Annotation
vbWhite 'White Line
psSolid 'Solid Line
2
=
=
=
=
=
=
=
iprtChannel
59.85 'Y Coordinate
ipasLineY 'LineY Annotation
vbWhite 'White Line
psSolid 'Solid Line
2
LineX Example
LineY Example
How to Remove Annotations
To remove an annotation, execute the DeleteAnnotation method, passing the unique index value
of the annotation to delete. To delete all annotations, execute the RemoveAllAnnotations
method. Note that these methods are on the main component interface.
59
Annotation Click Event
This event, actually an event on the main component interface, is fired every time a user clicks
on an annotation when the Select Button is engaged. The event passes back the Index of the
Annotation that is clicked.
‘Visual Basic
OnClickAnnotation(ByVal Index As Long)
//Visual C++
CProgramDlg::OnClickAnnotation(long Index)
//Delphi-Kylix-C++ Builder
TForm1.iPlot1ClickAnnotation(Index: Integer)
Properties
BrushColor
Enabled
Height
PenStyle
Reference
TextRotation
X2
Y
BrushStyle
FontColor
Name
PenWidth
Style
Visible
X
ChannelName
Font
PenColor
PopupEnabled
Text
Width
Y2
Methods
Events
OnClickAnnotation
!
60
Chapter 10 – Data Cursors
The Cursor is a tool included with the Plot Pack components, which allows the user to display individual
data points on the screen in the Plot Legend. This tool is available for use from the integrated toolbar,
and can also be used by your program code through the built-in events and interfaces that support the
cursor.
The cursor tool work differently depending on the type of component being used. All of the cursors
display their data in a hint window next to the cursor. If you wish to display the cursor data in your own
window or in an external control, refer to the available events at the end of this chapter.
The Plot pack components support an unlimited number of cursors through code and through the runtime property editor. One cursor is automatically added for easy use by the cursor toolbar button.
Cursor Types
By default, the cursors are initially set as “Value X-Y” cursors, which in the iPlot component
draws a line perpendicular to the X-Axis and displays the X and Y data point values for a
particular channel. You can change the type of cursor either by right-clicking on the cursor at
run-time or through code by accessing the Cursor Object. You can also change the labels in the
popup menu for each cursor, customizing it for your particular application.
Value X-Y Cursor [ValueXY]
This cursor style displays the current X and Y-Axis value for a data point in a particular
channel. This example shows a data point on Channel #1 at X=40.0 and Y=2.0000.
61
Value X Cursor [ValueX]
This cursor style displays the current X-Axis value for a data point in a particular
channel. This example shows a data point on Channel #1 at X=40.0.
Value Y Cursor [ValueY]
This cursor style displays the current Y-Axis value for a data point in a particular
channel. This example shows a data point on Channel #1 Y=2.0000.
62
Period Cursor [DeltaX]
This cursor style displays the value of the distance between the two displayed cursors
when measuring two data points along the X-Axis. This example shows a data point on
Channel #1 at X=40.0 and Y=2.0000.
Peak-Peak Cursor [DeltaY]
This cursor style displays the value of the distance between the two displayed cursors
when measuring two data points along the Y-Axis. This example shows a peak-to-peak
distance value of 13.559.
63
Frequency Cursor [InverseDeltaX]
This cursor style displays the current X and Y-Axis value for a data point in a particular
channel. This example shows a data point on Channel #1 at X=40.0 and Y=2.0000.
Adding and Removing Cursors
To add a data cursor to the chart, simply execute the following method…
index = iPlot1.AddDataCursor
To delete a data cursor from the chart, simply execute the following method…
iPlot1.DeleteDataCursor(index)
To remove all data cursors from the chart, simply execute the following method…
iPlot1.RemoveAllDataCursors
you can set the properties of the data cursor, such changing the cursor style, the hint window
font, hint orientation, etc. [Note: Font properties in the example below will differ depending on
your compiler]
!
64
If you are using Interpolation to draw the trace line, please note that the Data Cursors
do not yet support the display of X or Y coordinate data for Interpolated trace lines.
The X and Y coordinate data will reflect Straight Line Traces only.
Data Cursor Example
iPlot1.DataCursor(index).Style
iPlot1.DataCursor(index).MenuItemCaptionValueXY
iPlot1.DataCursor(index).MenuItemVisibleValueX
iPlot1.DataCursor(index).MenuItemVisibleValueY
iPlot1.DataCursor(index).ChannelName
iPlot1.DataCursor(index).FontColor
=
=
=
=
=
=
ipcsValueXY
"XY Coordinates"
False
False
"Channel 1"
vbCyan
CursorXValue = iPlot1.DataCursor(index).ValueX
CursorYValue = iPlot1.DataCursor(index).ValueY
Accessing Individual Cursor Properties
There are many properties that can be used to customize the look and feel as well as the
operation of the cursor in your application.
Controlling User Popup Menu
By default, the popup menu allows users to change the style of the cursor. You can
control the user selections that are available by using the “MenuItemCaption” and
“MenuItemVisible” properties of the cursor object. The “MenuItemCaption”
properties allow you to customize the label used to describe the type of cursor style
available to the user. The “MenuItemVisible” properties allow you to customize
whether a particular cursor style is available to the user.
Controlling Hints
You can control the behavior of the cursor by using the available hint properties of the
cursor object. The HintHideOnRelease property is useful if you only want the hint
window to be visible when the user has clicked, and holds down the mouse button on a
particular cursor. You can also choose to hide the hint permanently using the HintShow
property so that you can show cursor data outside the component. Use the
OnCursorChange event on the main plot interface to be notified that the cursor has
changed position.
Controlling Cursor Pointers
You can programmatically change the cursor positions by using the Pointer1Position
and Pointer2Position properties. The Pointer2Position property is only valid for those
cursors that use two pointers.
iPlot Component Specific Notes
If the cursor is in-between data points in a particular channel, then the cursor will display linear
interpolated (y = mx + b) values. Also, the value displayed for each channel depends on which
X and Y-Axes that channel is associated with.
65
iXYPlot Component Specific Notes
The iXYPlot Component’s cursor, if in ipcsValueXY mode, will display a crosshair cursor instead of
a single line. This is due to the fact that there can be many different y solutions from any particular
x value.
Cursor Events
If you need to know when the user is moving the cursor tool on the DataView area, you can use the
OnCursorChange event to detect this. You can then query the DataCursor object for the current
Pointer1Position and Pointer2Position properties (depending on the Cursor Style) to determine the X
and Y values for that channel under the cursor or to determine the calculated values from specialized
cursor styles.
OnCursorChange(CursorIndex as Integer)
iComponent.DataCursor(CursorIndex).Pointer1Position
iComponent.DataCursor(CursorIndex).Pointer2Position
66
Properties
ChannelName
FontColor
HintOrientationSide
MenuItemCaptionDeltaX
MenuItemCaptionValueX
MenuItemVisibleDeltaX
MenuItemVisibleValueX
Name
PopupEnabled
UseChannelColor
ValueY
Color
Font
HintPosition
MenuItemCaptionDeltaY
MenuItemCaptionValueXY
MenuItemVisibleDeltaY
MenuItemVisibleValueXY
Pointer1Position
Status
Visible
Enabled
HintHideOnRelease
HintShow
MenuItemCaptionInverseDeltaX
MenuItemCaptionValueY
MenuItemVisibleInverseDeltaX
MenuItemVisibleValueY
Pointer2Position
Style
ValueX
Methods
Events
OnDataCursorChange
!
67
Chapter 11 - Limits
Chapter 11 - Limits
Limits (a.k.a. Process Windows) are objects that you can define and place on the chart. This is useful
for showing a set of limits or process windows where data should be contained.
There are six types of Limits and Process Windows (referred to as Band Limits) available in the chart.
Each limit is associated with an X-Axis and Y-Axis. Band Limits can be setup to be drawn as a filled
band or two lines. You can create an unlimited number of limits and limit types per chart.
LineX
This type of limit is a vertical line positioned at a specific X-Axis value, perpendicular to the XAxis. You can modify the line style, color, and width. Do not use the line width to simulate a
band limit as the line width is in pixels (not accurate for limit use), and the band limits use the
actual axis values.
LineX Limit
68
Chapter 11 - Limits
LineY
This type of limit is a vertical line positioned at a specific Y-Axis value, perpendicular to the YAxis. You can modify the line style, color, and width. Do not use the line width to simulate a
band limit as the line width is in pixels (not accurate for limit use), and the band limits use the
actual axis values.
LineY Limit
BandX
This type of limit is a set of two lines or a filled-band positioned at two specific X-Axis values,
perpendicular to the X-Axis. You can modify the starting X Value and ending X Value to create
the band. You can also modify fill properties such as fill style and fill color. If you specify a fill
style of clear, then the band will be comprised of two parallel lines.
69
Chapter 11 - Limits
BandY
This type of limit is a set of two lines or a filled-band positioned at two specific Y-Axis values,
perpendicular to the Y-Axis. You can modify the starting Y Value and ending Y Value to create
the band. You can also modify fill properties such as fill style and fill color. If you specify a fill
style of clear, then the band will be comprised of two parallel lines.
PolyBandX
This type of limit is a dynamic set of connected points (two X Values, and one Y Value),
resulting in two lines or a filled-band perpendicular to the X-Axis. Use AddBandElement to add
individual band elements to make up the entire band. Each band element will be connected to
the previous and next band element to make up the band.
70
Chapter 11 - Limits
PloyBandY
This type of limit is a dynamic set of connected points (two Y Values, and one X Value),
resulting in two lines or a filled-band perpendicular to the Y-Axis. Use AddBandElement to add
individual band elements to make up the entire band. Each band element will be connected to
the previous and next band element to make up the band.
Adding and Removing Limits
To add a data limit to the chart, simply execute the following method…
index = iPlot1.AddLimit
you can set the properties of the limit, such as changing the limit style, the limit fill (if
applicable), and the limit color.
To remove a limit from the chart, simply execute the following method…
iPlot1.DeleteLimit(Index)
To remove all limits, simply execute the following method…
iPlot1.RemoveAllLimits
71
Chapter 11 - Limits
Single-Line Limit Examples
iPlot1.Limit(index).Style
iPlot1.Limit(index).Color
iPlot1.Limit(index).LineStyle
iPlot1.Limit(index).Line1Position
=
=
=
=
iplsLimitY
vbRed
psSolid
25 'Position on Y-Axis
iPlot1.Limit(index).LineStyle
=
=
=
=
iplsLimitX
vbRed
psSolid
25 'Position on X-Axis
iPlot1.Limit(index).FillStyle
=
=
=
=
=
iplsLimitY
vbRed
bsDiagCross
=
=
=
=
=
iplsLimitX
vbRed
bsDiagCross
Band Limit Examples
Poly Band Limit Examples
= iplsLimitY
= vbRed
= bsDiagCross
iPlot1.Limit(index).AddBandElement(25, 75, 45) '25: Position on X-Axis
'75: Upper limit Y-Axis
'45: Lower limit Y-Axis
72
Chapter 11 - Limits
= iplsLimitX
= vbRed
= bsDiagCross
iPlot1.Limit(index).AddBandElement(25, 75, 45) '25: Position on Y-Axis
'75: Upper limit X-Axis
'45: Lower limit X-Axis
To remove all band elements, use the ClearAllElements method…
iPlot1.Limit(index).ClearAllElements 'Remove All Band Elements
73
Chapter 11 - Limits
Properties
Color
Line1Position
LineWidth
Style
YAxisName
Enabled
Line2Position
Name
Visible
FillStyle
LineStyle
PopupEnabled
XAxisName
Refer to the help files for more detailed information about this plot object’s properties.
Methods
AddBandElement
ClearAllElements
Refer to the help files for more detailed information about this plot object’s methods.
Events
74
Chapter 12 - Labels
Chapter 12 - Labels
The Label Objects hold text that can be used as a horizontal chart title, common stacked-axes
vertical title, footer, etc. By default, one label object is added to the chart to hold the chart title.
You can add any number of label objects to the Plot component and change their position and
properties using our built-in property editor and visual layout manager.
Label
!
Labels
For backward compatibility with older versions of our Plot Components, the first
label cannot be removed. This is due to the fact that the first label is mapped to
the depreciated title properties of the component. All Title properties such as
TitleText, TitleFont, and TitleMargin are mapped to the first label object.
Remember that it is easier to add labels and setup their properties using our builtin property editor. The examples here illustrate manipulating the object through
code.
75
Chapter 12 - Labels
How to Add Labels
To add a Label to the chart, simply execute the following method…
index = iPlot1.AddLabel
The return value is a unique index for use in manipulating the object. After adding the object, you can
set the properties of the label, such as setting the object associated font properties or setting the caption.
[Note: Font properties in the example below will differ depending on your compiler]
Horizontal Label Example
iPlot1.Labels(Index).Alignment
iPlot1.Labels(Index).Caption
iPlot1.Labels(Index).Font
iPlot1.Labels(Index).Horizontal
iPlot1.Labels(Index).MarginBottom
iPlot1.Labels(Index).MarginLeft
iPlot1.Labels(Index).MarginRight
iPlot1.Labels(Index).MarginTop
=
=
=
=
=
=
=
=
iahCenter
"Sample Chart X vs. Y"
"Times New Roman"
True
0.25
0
0
0.25
=
=
=
=
=
=
=
=
iahCenter
"Stacked Y-Axes"
"Times New Roman"
False
0.25
0
0
0.25
Vertical Label Example
iPlot1.Labels(Index).Alignment
iPlot1.Labels(Index).Caption
iPlot1.Labels(Index).Font
iPlot1.Labels(Index).Horizontal
iPlot1.Labels(Index).MarginBottom
iPlot1.Labels(Index).MarginLeft
iPlot1.Labels(Index).MarginRight
iPlot1.Labels(Index).MarginTop
How to Remove Labels
To remove a label, execute the DeleteLabel method, passing the unique index value of the label
to delete. To delete all labels, execute the RemoveAllLabels method. Note that these methods
are on the main component interface.
76
Chapter 12 - Labels
Properties
Alignment
FontColor
Horizontal
MarginRight
PopupEnabled
Visible
Caption
Font
MarginBottom
MarginTop
StartPercent
Width
Enabled
Height
MarginLeft
Name
StopPercent
ZOrder
Methods
Events
77
Chapter 13 - Visual Layout Manager
The Visual Layout Manger included in each Plot Pack component enables you to easily layout your
chart plot objects with very little effort. The Layout Manager is available at design-time through our
custom property editors or available to your application users at run-time with our run-time property
editor.
The Layout Manger makes it possible to visually layout your chart without writing a single line of code
and without using complicated properties. You can of course use your own programming code to make
changes to the chart layout at runtime, but the Layout Manger makes it simple and easy to do visually.
To access the Visual Layout Manger, open up the property editor for the Plot Component and click on
the “Layout” tab.
The Plot control on your form is represented by the blue rectangle with icons for all of the current layout
objects contained within the control such as the X-Axis, Y-Axis, Data View, Legend, and Toolbar
Layout Objects. The Data View Object is fixed in position and in size (it resizes to fill all available
space) and all other objects move in relation to the Data View.
78
Tutorial
How to Move Objects
Click and hold down the left mouse button on the Y-Axis. Notice that the Y-Axis object turns from
a gray background to a yellow background on your screen.
Drag and drop the “Y-Axis 1” object in-between the Data View and “Legend 1”. Notice that a
rectangle will move along with your cursor. This indicates that you are moving the object over valid
positions that are available.
79
Release the mouse button to complete the move of the Y-Axis object. Notice that the Y-Axis object
has moved to the position specified and all of the other objects have been repositioned to maximize
the size of the Data View area.
80
Resizing Plot Objects
To resize a Plot Object, such as an axis, hold your mouse cursor over one of the ends of the
object to be resized. Notice that the mouse cursor changes to a double arrow pointer, indicating
that you are about to resize the Plot Object.
Hold down the left mouse button. Notice that the object is highlighed in yellow to indicate that
you are resizing that particular object on your screen.
81
Drag your mouse to resize the object. Notice that the object dynamically changes size as you resize
it. Release the mouse button when finished.
Note: The only objects that can be resized at this time are the X and Y-Axis objects.
82
How to Stack Axes
The Visual Layout Manger make it easy to stack multiple axes on top of one another.
To stack axes, first make sure that the axes to stack are sized so that they don’t overlap. If the axes
overlap, then the stacking process will not work.
83
Drag and drop one of the axis objects on top of another axis that you wish to stack with.
Release the mouse button and the two axes will stack, with all other plot objects readjusting.
84
Rotating X and Y-Axes
To swap the positions of the X and Y-Axes, right-click on the Data View object and select “X-YAxes Reverse” . This will reverse the positions of all X and Y-Axes objects.
Reversing or Rotating Axes has no effect on DataView aligned Annotations. The
reference values specified are always left to right (0-100) and bottom to top in relation
to the Data View.
85
Chapter 14 - Adding Data
Adding Data to the Plot Pack components is a very easy and straightforward process. Since the channels
in the chart are not required to be synchronous, you can simply add your data points in X/Y coordinate
pairs as required.
If you will be adding data from unsynchronized events (such as from data
acquisition hardware) and run into a problem where some data will cause
other data to scroll off the screen, take a look at the multiple X and Y-Axis
support. You can have each channel assigned to its own axes, independent
of other channels. You can then add data in a synchronous or asynchronous
manner as needed.
There are currently four methods for adding data to the Plot Components.
AddXY
This method allows you to add data to the plot component in x and y data value pairs. This is the
simplest method to use when adding data to the Plot Components. This method is compatible
with both the iPlot and iXYPlot components.
Complete AddXY Example
The following example assumes that you have placed a single iPlot component on your form
along with a standard push button named “PlotButton”. When you initially create the plot
object, it automatically adds one X-Axis, one Y-Axis, and one Channel for you by default.
Each example will plot 100 random Y data points with an increasing X value.
Visual Basic
Private
Dim
Dim
Dim
Sub PlotButton_Click()
x As Long
XData As Double
YData As Double
For x = 1 To 100
'Increment X Data
XData = XData + 1
'Generate Random Y Data
YData = Rnd(1) * 100
'Plot XY Data Pair
iPlotX1.Channel(0).AddXY XData, YData
Next x
End Sub
86
Visual C++ [Disp Inteface]
//Place at top of cpp file
#include "iplotx.h"
#include "iplotlabelsx.h"
void CFormDlg::OnPlotButton()
{
double XData;
double YData;
XData = 0;
YData = 0;
for(int i=0; i<100; i++)
{
//Increment X Data
XData = XData + 1;
//Generate Random Y Data
YData = (rand()/(double)RAND_MAX)*100;
//Plot XY Data Pair
m_iPlotX.GetChannel(0).AddXY(XData, YData);
};
}
Visual C++ [High-Speed iDispatch Interface]
#import "iPlotLibrary.tlb" named_guids
#include "atlbase.h"
extern
CComModule _Module;
using namespace iPlotLibrary;
{
double XData;
double YData;
CWnd*
m_Wnd;
IUnknown* m_iUnknown;
CComPtr<iPlotLibrary::IiPlotX> iPlotX1;
//Get interface to Plot Component
//Assuming that name of component on form is IDC_IPLOTX1 in this example
m_Wnd
= GetDlgItem(IDC_IPLOTX1);
m_iUnknown = m_Wnd->GetControlUnknown();
m_iUnknown->QueryInterface(__uuidof(iPlotLibrary::IiPlotX), \
(LPVOID*)&iPlotX1);
87
XData = 0;
YData = 0;
for(int i=0; i<1000000; i++)
{
//Increment X Data
XData = XData + 1;
//Plot XY Data Pair
iPlotX1->Channel[0]->AddXY(XData, YData);
};
}
C++ Builder
#include <stdlib.h> //Place at top of cpp file
void __fastcall TForm1::PlotButtonClick(TObject *Sender)
{
double XData;
double YData;
XData = 0;
YData = 0;
for(int i=0; i<100; i++)
{
//Increment X Data
XData = XData + 1;
YData = (random(100));
//Plot XY Data Pair
iPlot1->Channel[0]->AddXY(XData, YData);
};
}
88
Delphi/Kylix
procedure TForm1.PlotButtonClick(Sender: TObject);
var
x
: Integer;
XData : Double;
YData : Double;
begin
for x := 1 To 100 do
begin
//Increment X Counter
XData := XData + 1;
//Generate Random Data
YData := Random(100);
//Plot XY Data Pair
iPlot1.Channel[0].AddXY(XData, YData);
end;
end;
Internet Explorer
[Client-Side, VBScript]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<title>Internet Explorer Plot Pack Example</title>
</head>
<body>
<object classid="clsid:1791C036-8981-492A-BD28-F2331BC9B7C7" id="iPlotX1"
width="500" height="200"></object>
<input type="button" value="Plot" name="PlotButton">
<script LANGUAGE="VBScript">
<!-Sub PlotButton_OnClick()
Dim x
Dim XData
Dim YData
For x = 1 To 100
'Increment X Counter
XData = XData + 1
'Generate Random Data
'Plot XY Data Pair
Next
end sub
-->
</script>
</body>
</html>
89
Sample Output from Example
Special ActiveX Example:
When iterating through a large loop and access sub objects of the ActiveX plot component, it is
more efficient to create a temporary variable to keep track of the sub object in memory instead of
having to access it during each iteration of the loop.
In the example above, we go through a loop 100 times. We access the channel sub object 100
times for each AddXY method. There is a very small performance penalty when accessing the
channel, which is magnified when looping, and can be noticeable with very large loops. To
rectify this, we can sacrifice a small amount of memory to greatly speed up large loops. We will
set a local variable to reference the channel sub-object only once, and then reuse the local
variable in the loop.
In the following example we will create a temporary variable to hold the channel sub object and
will loop through 1,000,000 data points. You can flip between the method used in the example
above and the example shown below to see the difference in speed. (Approximately 2x-4x faster
using the local variable method shown below depending on your compiler).
90
Visual Basic
Private
Dim
Dim
Dim
Dim
x As Long
XData As Double
YData As Double
TempChannel as iPlotChannelX
Set TempChannel = iPlotX1.Channel(0)
For x = 1 To 1000000
'Increment X Data
XData = XData + 1
'Plot XY Data Pair
TempChannel.AddXY XData, YData
Next x
End Sub
Visual C++ [Disp Interface]
#include "iplotx.h"
{
double XData;
double YData;
CiPlotChannelX TempChannel;
XData = 0;
YData = 0;
TempChannel = m_iPlotX1.GetChannel(0);
for(int i=0; i<1000000; i++)
{
//Increment X Data
XData = XData + 1;
//Plot XY Data Pair
TempChannel.AddXY(XData, YData);
};
}
91
extern
CComModule _Module;
{
double XData;
double YData;
CWnd*
m_Wnd;
CComPtr<iPlotLibrary::IiPlotChannelX> tempChannel;
m_Wnd
(LPVOID*)&iPlotX1);
tempChannel = iPlotX1->Channel[0];
XData = 0;
YData = 0;
for(int i=0; i<1000000; i++)
{
//Increment X Data
XData = XData + 1;
//Plot XY Data Pair
tempChannel->AddXY(XData, YData);
};
}
92
Internet Explorer
<html>
<head>
</head>
<body>
Dim x
Dim XData
Dim YData
Dim TempChannel
For x = 1 To 1000000
XData = XData + 1
'Plot XY Data Pair
Next
end sub
-->
</script>
</body>
</html>
Other Data Adding Methods
The iPlot component has several other methods for adding data that are specific only to the iPlot
component. These methods make it very easy to add data in real-time using the component’s
built-in timer or the computer’s internal system clock.
93
AddYElapsedSeconds
This method adds Y data that you specify, and Y data from an internal “seconds” counter. This is
useful if you are acquiring data in real-time and wish to use the built-in seconds timer and you do not
have access to independent time data from your data source.
iComponent.Channel(0).AddYElapsedSeconds(YData)
!
The time value added for the x-axis is calculated as the number of seconds that
have elapsed since the date/time value of the ElapsedStartTime property. To set
the ElapsedStartTime property to the current system time (i.e. Reset the Elapsed
Time used by the AddYElapsedSeconds and AddYElapsedTime methods),
execute the ResetElapsedStartTime method to set the ElapsedStartTime
property to the current system time.
AddYElapsedTime
This method adds Y data that you specify and Y data from an internal time counter. This is useful if
you are acquiring data in real-time and wish to use the built-in timer and you do not have access to
independent time data from your data source.
iComponent.Channel(0).AddYElapsedTime(YData)
DateTime Note: the X value that is used is in Date/Time format [i.e. 1 Day = 1, 1 hour = 1/24, 1
minute = 1/(24*60)]. Refer to the section on Date/Time formats for more information on using
Date/Time values.
AddYNow
This method adds Y data that you specify, and Y data from your computer’s internal system clock
(Operating System’s Clock). This is useful if you are acquiring data in real-time and wish to use
current system time and you do not have access to independent time data from your data source.
iComponent.Channel(0).AddYElapsedTime(YData)
DateTime Note: the X value that is used is in Date/Time format [i.e. 1 Day = 1, 1 hour = 1/24,
1minute = 1/(24*60)]. Refer to the section on Date/Time formats for more information on using
Date/Time values.
If you have a service or program that automatically runs on your computer to
synchronize your time with the NIST time computers via the internet, with
your corporate network servers, or any other program that may modify your
system clock, you may run into problems using this method. This is because
the chart (and your actual data) expects time to increment properly. It is
recommended that you do not use this method with such utilities, as there can
be unpredictable results.
94
AddXYArrays
This method adds data points from two variant arrays, each containing x and y values. The
number of elements in each array must be identical (i.e. if XArray contains 100 elements,
YArray must contain 100 elements), otherwise an exception will be generated)
iComponent.Channel(0).AddXYArrays(XArray, YArray)
This procedure is able to handle variant arrays that start at element 0 or any value that you
require. If you array starts at element XData(10), then that value will be used to add the first
data point.
AddEmpty
This method sets a data point as an empty data point. An empty data point is a data point with no
X or Y Value, only an index placeholder for the data point. Since this data point doesn’t have an
X or Y Value, no Data Marker is shown and the trace line will not be drawn to this data point.
This is useful for adding data point “placeholders” so that you can set the X and Y value of the
data point at a later time.
Index = iPlot1.Channel(0).AddEmpty()
'You can later set the X and Y
'data point by using the DataX
iPlot1.Channel(0).DataX(Index)
iPlot1.Channel(0).DataY(Index)
coordinates of this
and DataY properties
= XValue
= YValue
iPlot1.Channel(0).DataX(Index) = 10.5
iPlot1.Channel(0).DataY(Index) = 57.4
See Chapter “Null Data and Empty Data Handling” for more information.
AddXNull [iPlotX component only]
This method adds a data point at a specified X data point. The Y value will be set to Null.
iComponent.Channel(0).AddXNull(XData)
iComponent.Channel(0).AddXNull(10.5)
95
AddNull [iXYPlotX component only]
•
This method adds a data point as a null data point (both X and Y coordinates). You must
first add a data point using AddXY using dummy data, obtain the index of that data point,
and then pass that index to set the data point to null.
Index = iPlot1.Channel(0).AddNull()
Modifying/Reading Data
If you need to modify or read a data point after adding it to a channel, you can use the following
property to change the X or Y value of a data point. You will need to know the index of the data
point to make this modification(the index was passed back by the AddXY and other add data
functions)…
'Add a data point and get the data point's Index
Index = iComponent.Channel(0).AddXY(10.5, 20.5)
'Change the data point's X and Y Value
iComponent.Channel(0).DataX(Index) = 11
iComponent.Channel(0).DataY(Index) = 21
'Read the data point's X and Y Value
DataPointXValue = iComponent.Channel(0).DataX(Index)
DataPointYValue = iComponent.Channel(0).DataY(Index)
If you are using the iPlot component, you can also use a special method on the channel called
GetYInterpolated. If you know a X value, then you can query the component for the
corresponding Y value of a data point at the X value. Since double values are not precise, the Y
value returned will be interpolated using the trace line drawn between a data point before and
after the given X value.
YValue = iComponent.Channel(Index).GetYInterpolated(XValue)
Note: this method does not exist on the iXYPlot component since there can be many numerous
solutions to any given X value.
96
Running Y-Value Min, Max, and Mean
The Channel objects have three specialized properties that provide the following information
about the channel without requiring extensive calculations by the component…
•
•
•
RunningYMax
RunningYMin
RunningYMean
These values represent the Maximum Y, Minimum Y, and Mean Y values in the specified
channel. Since these values are calculated as you add data, accessing these values is very quick
since calculation of the max, min, and mean do not have to be done on every query.
'Use these values to get the running mean of the corresponding values
'This method is quick because it is calculated during every addition
'of a data point instead of every time the value is checked
YMaxValue = iComponent.Channel(Index).RunningYMax
YMinValue = iComponent.Channel(Index).RunningYMin
YMeanValue = iComponent.Channel(Index).RunningYMean
The drawback to using these values is that if you change previous data points, these values will
no longer be valid. To refresh these values if you change previous data points, call GetYMax,
GetYMin, and/or GetYMean to force a recalculation of these values. You can use the GetYMax,
GetYMin, and GetYMean values if you wish to have these values recalculated every time, but
you will see a performance decrease due to the overhead.
'Use these
YMaxValue
YMinValue
YMeanValue
!
values to force a recalculation for every call
= iComponent.Channel(Index).GetYMax
= iComponent.Channel(Index).GetYMin
= iComponent.Channel(Index).GetYMean
If you are utilizing Empty or Null data points, the RunningYMean value will
not be correct, as it does not exclude these values from the Mean calculation.
97
Empty Data Points
In some situations, you may want to add a data point but not specify its X and/or Y Value. When
a data point is missing it’s X and/or Y value, the data point is ignored by the Plot component
when drawing the trace line. This results in a trace line between two valid data points and
ignoring the empty data point.
In contrast, null data points create a “break” in the trace line.
To add an empty data point, use the AddXEmpty if you are using the iPlot component to add an
empty data point with an X value and an empty Y value. Use the AddEmpty method if you are
using the iXYPlot component to add an empty data point with no X or Y value. You can then
use the DataX and/or DataY properties to specify the data point X and/or Y values at a later time.
'Add an empty data point to the iPlot component
Index = iComponent.Channel.AddXEmpty(10.5) 'Specify the X coordinate
'Add an empty data point to the iXYPlot component
Index = iComponent.Channel.AddEmpty()
98
Chapter 15 - Null Data Handling
By default, the Plot Pack components are setup to draw a trace line between every point on the chart in
the order that they are added to the channel. The Null Data handling features allows you to specify
certain Y data values as null data points, preventing the chart from connecting these data points to actual
data points.
This feature is typically used in data acquisition hardware applications where you lose connection with
the hardware, but want to show on the chart that no data was collected at a particular X (usually Time
Axis value) and you have an undefined Y value (a.k.a. Null Data Point).
For example, notice the break in the trend line between the 4th and 6th data points. The 5th data point was
plotted with a null Y value, so it does not show up in the chart and no line is drawn through that data
point.
6th Point
4th Point
Y-Axis
Null Y Data Point Added at
This X Value (5th point)
X-Axis
Adding a Null Y Data Point at a Specific X Data Point (iPlot Only)
The AddXNull() method is used to add a specified X data point with the corresponding Y data
point being null (i.e. undefined). Simply pass the X value (e.g. 2.56)
iComponent.Channel(0).AddXNull(2.56)
Adding a Null X & Y Data (iXYPlot Only)
The AddNull() method is used to add a data point with both an X and Y null value.
iComponent.Channel(0).AddNull()
99
Setting a Null Y Data Point at a Specific X Data Point
The DataNull() method is used to change a Y data point to a null value for an X/Y data point pair
that has already been plotted on the chart. Simply pass the X value (e.g. 2.56)
iComponent.Channel(0).DataNull(2.56)
Full Source Example
The following examples assume you have placed an iPlot Component on your form and have
placed a simple pushbutton named “PlotButton” on your form. The example will plot 50 random
data points with some random Null Data points for illustrative purposes.
Sample Output from Example
100
Visual Basic
Private Sub PlotButton_Click()
Dim x
As Long
Dim XData As Long
Dim YData As Long
For x = 1 To 50
XData = XData + 2
'85% of the time plot the X and Y Data Value
'15% of the time plot the X Value and Y as null
If Rnd(1) < 0.85 Then
'Plot X and Y Data Pair
Else
'Plot X Data and Y Null Data
iPlotX1.Channel(0).AddXNull XData
End If
Next x
End Sub
Visual C++ [Disp Inteface]
{
double XData;
double YData;
XData = 0;
YData = 0;
for(int i=0; i<50; i++)
{
XData = XData + 2;
//85% of the time plot the X and Y Data Value
//15% of the time plot the X Value and Y as Null
if ((rand()/(double)RAND_MAX) < 0.85)
{
//Plot X and Y Data Pair
m_iPlotX1.GetChannel(0).AddXY(XData, YData);
}
else
{
//Plot X Data and Y Null Data
m_iPlotX1.GetChannel(0).AddXNull(XData);
}
};
}
101
Visual C++ [High-Speed iDispatch Inteface]
extern
CComModule _Module;
{
double XData;
double YData;
CWnd*
m_Wnd;
m_Wnd
(LPVOID*)&iPlotX1);
XData = 0;
YData = 0;
for(int i=0; i<50; i++)
{
XData = XData + 2;
if ((rand()/(double)RAND_MAX) < 0.85)
{
iPlotX1->Channel[0]->AddXY(XData, YData);
}
else
{
iPlotX1->Channel[0]->AddXNull(XData);
}
};
}
102
Delphi/Kylix
procedure TForm1.PlotButtonClick(Sender: TObject);
var
x
: Integer;
XData : Double;
YData : Double;
begin
for x := 1 To 50 do
begin
XData := XData + 2;
YData := Random(100);
If Random(11) < 8.5 then
//Plot XY Data Pair
iPlot1.Channel[0].AddXY(XData, YData)
else
iPlot1.Channel[0].AddXNull(XData);
end;
end;
end;
C++ Builder
#include <stdlib.h> //Place at top of cpp file
void __fastcall TForm1::PlotButtonClick(TObject *Sender)
{
double XData;
double YData;
XData = 0;
YData = 0;
for(int i=0; i<50; i++)
{
XData = XData + 2;
YData = (random(100));
if (random(11) < 8.5)
{
iPlot1->Channel[0]->AddXY(XData, YData);
}
else
{
iPlot1->Channel[0]->AddXNULL(Xdata);
}
};
}
103
Internet Explorer
<html>
<head>
</head>
<body>
Dim x
Dim XData
Dim YData
For x = 1 To 50
XData = XData + 2
'85% of the time plot the X and Y Data Value
'15% of the time plot the X Value and Y as null
If Rnd(1) < 0.85 Then
'Plot X and Y Data Pair
Else
'Plot X Data and Y Null Data
iPlotX1.Channel(0).AddXNull XData
End If
Next
end sub
-->
</script>
</body>
</html>
104
Chapter 16 - User Interface Control
This chapter will cover using the User Interface controls that included with the Plot Pack. These control
objects are available to your end user at runtime while using your compiled application.
The main user interfaces in the Plot Pack components that are available at runtime for the application
user are:
The Built-in Toolbar
The toolbar provides quick and easy to use control over the function of the chart by your end
user at runtime in your application. All functions are implemented inside of the chart without the
need to implement these in your own application code.
Button
Meaning
Resume Button: Resumes tracking on ALL axes
Pause Button: Pauses tracking for ALL axes
Axes Mode Buttons: Changes the mode that the axes are in
when using the mouse. The first icon puts the axes in scroll
mode. The second icon puts the axes in zoom mode.
Zoom In/Out Buttons: Zooms ALL axes in our out according to
the ZoomInOutFactor property..
Select Button: Used for selecting items in the data view area.
Generates events that can be used by the programmer to react to
selection of items such as data points, annotations, areas of the
data view, etc.
Zoom Box Button: Allows the user to draw a "Zoom Box" on
the DataView area to zoom ALL axes.
Cursor Button: Show or hide all data cursors. Values for each
channel are displayed in a hint window next to the cursor(s).
Edit Button: Brings up the Run-Time property editor for the
user to change most control properties.
Copy Button: Copies the current component image to the
clipboard.
Save Button: Brings up a dialog to allow the user to save chart
data to currently supported file types.
Print Button: Allows user to print image of chart to printer.
105
Scrollable and Zoomable Axes
All X and Y-Axes can be scrolled or zoomed by the user at runtime, even while data is being
plotted to the chart.
By default, the chart is set into “Scroll Mode”
. This means that when a user clicks on an
axis, holds down the mouse button, and drags the cursor, that axis will scroll up or down
depending on the user’s direction of movement.
When the user selects “Zoom Mode”
from the toolbar, clicking and dragging the axis will
cause the axis scale to zoom in our out, depending on the user’s direction of movement (Up
Zooms In, Down Zooms Out, Left Zooms Out, Right Zooms In).
Whenever an axis is scrolled or zoomed, tracking on that axis will pause until restarted. You can
and Pause
pause or resume tracking on all axes by using the Resume
right-clicking on an individual axis and toggling “Tracking Enabled”.
Buttons, or by
Zooming Tools
There are three tools available to the user to zoom all axes at the same time…
Zoom In Button: this tool will zoom all axes according to the
ZoomInOutFactor property.
Zoom Out Button: this tool will de-zoom all axes according to the
ZoomInOutFactor property.
Zoom Box Button: this tool will allow a user to click and drag out a box on
the DataView area. All axes will be zoomed to display this selected area.
To reset the zoom, click on the Resume Button
. To accept the
modified zoom of the axis, right-click on the axis and select “Use New
Values”.
Select Tool
The select tool is used by the application end-user to select items in the data view area at runtime, such as annotations, data points, etc.
Cursor Tool
The cursor tool hides or shows all available cursors. See the chapter on the Cursor for more
detailed information.
106
Context Sensitive Right-Click Menus (Popup Menus)
Each object in the Plot Component has it’s own context sensitive right-click menu. The available
options depend on the object being selected.
Axis Object
You can resume or pause tracking on an individual axis by right-clicking on the axis and
selecting “Tracking Enabled”
If the user has zoomed or scrolled the axis, the option “Use New Values” will be
available. This will change the properties of the axis to use the new Min and Span values
that correspond to the scrolled or zoomed axis.
The edit menu item will allow the user to bring up the runtime property editor for this
object.
DataView Object
Right-Clicking on the DataView will allow the user to bring up the runtime property
editor for this object.
Toolbar Object
Right-Clicking on the Toolbar will allow the user to bring up the runtime property editor
for this object.
Legend Object
Right-Clicking on the Legend will allow the user to bring up the runtime property editor
for the selected channel.
DataCursor Object
Right-Clicking on a Data Cursor will allow the user modify the properties and
functionality of the selected Data Cursor object.
You can disable the Popup Menus on each individual object by using the
Enabled and PopupEnabled properties of each plot object. For example,
to keep the application user from scrolling the X-Axis, you can set the
Enabled property of the X-Axis to FALSE
(iComponent.XAxis(0).Enabled = FALSE). This will prevent the user
from interacting with the X-Axis with either the mouse or keyboard input
devices.
107
Runtime Property Editor
The runtime property editor allows your application user to have complete control over the plot
component control at runtime. Some features are disabled in the runtime property editor, such as
adding and deleting axes or channels, since these functions are to be handled by the application’s
code and may lead to problems and program errors at runtime.
The Runtime Property allows the user to make changes to almost all aspects of the control during
execution such as modifying axes properties, changing channel properties, using the Visual
Layout Manager, etc.
There are two ways that your application user can directly access the Runtime Property Editor at
runtime…
Right-Click on Plot Object
When a user right-clicks on a Plot Object and selects “Edit…”, the runtime property editor will
be displayed along with the particular Plot Object that was selected (Such as The X-Axis or the
particular channel selected in the Legend).
iComponent1.UserCanEditObjects = FALSE
You can prevent the user from being able to bring up the runtime property
editor through right-clicks by setting the UserCanEditObjects property to
FALSE.
Preventing or Disabling UI Interaction
You can disable or enable the following on the component as a whole or on a specific plot object
as needed.
Disabling All UI Interaction on a Plot Object
Set the Enabled property on each Plot Object, such as the Axis, to prevent scrolling, the
legend to prevent selection, etc. All plot objects support the Enabled property, but some
objects don’t accept user interaction at this time (such as limits) so this property is
ignored.
iComponent.XAxis(0).Enabled = False
iComponent.YAxis(0).Enabled = False
iComponent.Legend(0).Enabled = False
108
Disabling Popup Menu on a Plot Object or On Entire Component
Set the PopupEnabled property on each Plot Object, such as the Axis, to prevent the user
from bringing up the Popup Menu. All plot objects support the PopupEnabled property,
but some objects don’t accept user interaction at this time (such as limits) so this property
is ignored. The main plot interface supports the UserCanEditObjects which disables all
run-time property access by the application user, but does not disable all popup menus.
iComponent.UserCanEditObjects
iComponent.XAxis(0).Enabled
iComponent.YAxis(0).Enabled
iComponent.Legend(0).Enabled
=
=
=
=
False
False
False
False
Toolbar Runtime Property Editor Button
The Toolbar Runtime Property Editor Button
entire plot component control.
brings up the runtime property editor for the
iComponent1.Toolbar(0).ShowEditButton = FALSE
You can prevent the user from being able to bring up the runtime property
editor from the toolbar by setting the ShowEditButton property to FALSE
You will notice that the Runtime Property Editor is missing the OK, Apply, and Cancel button. When
changes are made by your application’s end-user, the changes are immediately reflected in the Plot
Component.
109
Chapter 17 - Tracking
Tracking is a general term for the Auto-Scale and Auto-Scrolling features of the Plot Pack. These
features pertain to how the axes react to the addition of new data to the chart with respect to the sizing of
the span of the axes and the position of the axes with respect to this new data. Tracking Data is
information from the channel, regarding newly added data points, that is passed to the axes so that they
can adjust according to your needs.
The Plot Pack Channel and Axes objects support a feature called Tracking. Whenever a channel draws
data to the DataView window, it sends Tracking Data to its associated X and Y-Axes. This tracking
data tells the axis where new data is being plotted so that the axis can scroll or adjust it various sizing
properties (Min, Max, and Span) to keep the newly added data in view.
Channel
Tracking Data
Tracking Data
X-Axis
Y-Axis
By default, the Plot Components Axes and Channel Tracking Settings are setup as follows…
•
X-Axis is setup for Smooth Scrolling. Whenever new data is added to the chart (assume data is
added from left to right), the X-Axis will smoothly scroll to keep the most recent data in view.
iComponent.Xaxis(0).TrackingStyle = iptsScrollSmooth
•
Y-Axis is setup for Scale Min Max Adjust. The axis will scale the Min and Span properties to
keep the new tracking data in view.
iComponent.Yaxis(0).TrackingStyle = iptsScaleMinMax
110
•
All Channels are set to have their tracking data sent to their associated axes
iComponent.Channel(0).TrackingStyle = iptsScrollSmooth
•
All Axes have their Tracking enabled so that they will adjust to new tracking data from the
channels.
iComponent.Xaxis(0).TrackingEnabled = TRUE
iComponent.Yaxis(0).TrackingEnabled = TRUE
You can independently setup your own scaling and tracking options for each axis and channel if you
wish if the default settings do not fit your needs. The next few sections will discuss the different
AutoScale and Tracking options that are available…
Tracking Styles
There are five different styles that can be set on each axis that control how the axes are Auto-Scaled
when new tracking data is received from each channel. All axes support the 1-2-5 rule which
provides “human readable” scales. See the chapter on AutoScale and AutoLabel for more
information on the automatic scaling and label features of the Plot Pack.
1-2-5 Rule: This is a feature of the AutoScale capability built into the axes of
all Plot Pack components. The rule has been designed to provide major tick
labels that are “human readable”. In studies, most people like to see numbers
increment by numbers that are multiples of 1, 2, or 5. For example, on a scale
that is between 0 and 100, people like to see a scale that increments like 0, 10,
20, 30, 40, 50, 60, 70, 80, 90, and 100. If there is not enough room on the
chart, then the next best “Human Readable” format is 0, 20, 40, 60, 80, 100.
A scale of 0, 17, 33, 50, 67, 83, and 100 would not fit into the 1-2-5 rule, and
wouldn’t look good to a human anyway. The 1-2-5 Rule will ensure that the
scales always look professional. Refer to the AutoLabel and AutoScale
Chapter for more information on the 1-2-5 Rule.
ScaleMinMax [Y-Axis Default]
This tracking mode will adjust the min and span properties on the axis to ensure that new data
being added to the channel is kept in the visible DataView area. This is generally used with the
Y-Axis for Strip Chart applications.
iComponent.Xaxis(0).TrackingStyle = iptsScaleMinMax
iComponent.Yaxis(0).TrackingStyle = iptsScaleMinMax
111
ScaleMax
This tracking mode will adjust only the max properties on the axis to ensure that new data being
added to the channel is kept in the visible DataView area. If tracking data indicates that the data
is below the min property of the axis, then the min value will not be changed.
iComponent.Xaxis(0).TrackingStyle = iptsScaleMax
iComponent.Yaxis(0).TrackingStyle = iptsScaleMax
ScaleMin
This tracking mode will adjust only the min properties on the axis to ensure that new data being
added to the channel is kept in the visible DataView area. If tracking data indicates that the data
is above the max property of the axis, then the max value will not be changed.
iComponent.Xaxis(0).TrackingStyle = iptsScaleMin
iComponent.Yaxis(0).TrackingStyle = iptsScaleMin
ScrollSmooth [X-Axis Default]
If the data is off axis, then this tracking mode will adjust the axis to show the new tracking data
at the end of the scale. This style is generally used with the X-Axis for Strip Chart applications.
iComponent.Xaxis(0).TrackingStyle = iptsScrollSmooth
iComponent.Yaxis(0).TrackingStyle = iptsScrollSmooth
Scroll Page
If the data is off axis, then this tracking mode will adjust the axis in discrete blocks (will show
next major tick) to show the new tracking data at the end of the scale. This style is generally used
with the X-Axis for Strip Chart applications.
iComponent.Xaxis(0).TrackingStyle = iptsScrollPage
iComponent.Yaxis(0).TrackingStyle = iptsScrollPage
ExpandCollapse
This tracking mode will adjust the min and span properties on the axis to ensure that all data
being added to the channel is kept in the visible DataView area. It will also ensure that the all
visible data is expanded to the maximum viewing size within the data view by sizing the span up
and down and the data changes in the viewable area.
Warning!: This style is not recommended for all situations because the routines used to achieve
this effect can place a large load on the computer’s processor under certain situations.
iComponent.Xaxis(0).TrackingStyle = iptsExpandCollapse
iComponent.Yaxis(0).TrackingStyle = iptsExpandCollapse
112
Tracking Align First Styles
There are four styles that can be used to instruct the axes on how to align themselves when the first
data point is plotted to the chart. You can have the data begin plotting on one extreme side of the
chart or another depending on this setting.
Min
This style adjusts the axis to show the first data point on the beginning of the scale.
iComponent.Xaxis(0).TrackingAlignFirstStyle = ipafsMin
iComponent.Yaxis(0).TrackingAlignFirstStyle = ipafsMin
Example TrackingAlignFirstStyle Set to ipafsMin
Max
This style adjusts the axis to show the first data point on the end of the scale.
iComponent.Xaxis(0).TrackingAlignFirstStyle = ipafsMax
iComponent.Yaxis(0).TrackingAlignFirstStyle = ipafsMax
113
Example TrackingAlignFirstStyle Set to ipafsMax
Auto
This style leaves the axis unchanged if the first data point is already in view. If the first data
point is out of view, then the axis is adjusted to show the first data point on the beginning of the
scale.
iComponent.Xaxis(0).TrackingAlignFirstStyle = ipafsAuto
iComponent.Yaxis(0).TrackingAlignFirstStyle = ipafsAuto
None [All Axis Default]
The axes are not adjusted on the first data point. This is the default for all axes and is the most
commonly used Align First Style.
iComponent.Xaxis(0).TrackingAlignFirstStyle = ipafsNone
iComponent.Yaxis(0).TrackingAlignFirstStyle = ipafsNone
Tracking Scroll Compress Max
This feature specifies the maximum span value that is used to compress the axis when it receives
tracking data. When the TrackingEnabled property is set to TRUE, the Span property will be
increased (Compressed) to include the new Tracking Data if the current Span property is less than
the TrackingSrollCompressMax property value.
114
Notice that the data in the plot has been plotted up to an X-Axis value of 100. If the
TrackingScrollCompressMax property is set to 500, then X-Axis span will begin to increase as new
data is being added. When the Span property reaches the same value as the
TrackingScrollCompressMax property, a value of 500, then the TrackingStyle will take over from
that point on. In a default chart, the X-Axis would begin to Smooth Scroll after the Span property
had reached a value of 500.
Example:
iComponent.Xaxis(0).TrackingScrollCompressMax = 500
Enabling and Disabling Tracking
You can enable or disable the transfer of tracking data from the Channel to the Axes by setting
independent properties on either the channel or axes. This gives you complete control over how
tracking is implemented.
115
Channel Tracking Properties
You can disable the transmission of tracking data that comes from a channel to a particular axis
by setting that channel’s XAxisTrackingEnabled or YAxisTrackingEnabled properties. This
allows you to only send tracking data to one, both, or none of the associated axes for this
channel. The default value is TRUE.
iComponent.Channel(0).XAxisTrackingEnabled = TRUE
iComponent.Channel(0).YAxisTrackingEnabled = TRUE
Axis Tracking Properties
You can disable the reception of tracking data for a particular axis by setting the
TrackingEnabled property for the axis. The default value is TRUE.
iComponent.XAxis(0).TrackingEnabled = TRUE
iComponent.YAxis(0).TrackingEnabled = TRUE
User Interaction
The end user of your application can also enable or disable tracking for all channels by using the
Pause and Resume buttons on the built-in toolbar. Refer to the chapter on the toolbar for more
information.
Manual Tracking
If you need to manually send tracking information to the axes, use the following procedure,
passing the new data…
iComponent.XAxis(Index).NewTrackingData(XData)
iComponent.YAxis(Index).NewTrackingData(YData)
iComponent.XAxis(Index).NewTrackingData(10.5)
iComponent.YAxis(Index).NewTrackingData(27.2)
If all you are interested in doing is preventing the axes from scrolling all together,
then you should turn off the Tracking on all axes. Set the TrackingEnabled
property to False for all axes. The effect will be that all of the axes will not
respond to tracking data, and will not scroll. If you want to prevent user’s from
scrolling the axes, set the Enabled property of the axis to False to prevent user
interaction with the axis.
116
Chapter 18 - Interpolation
This feature, sometimes referred to as Curve -Fitting though that is not always the case, is supported by
our iPlot component. Interpolation is the process by which a line or series is drawn according to an
estimation function or set of functions based on existing known data point values.
There are several types of Interpolation available for the channel object. All of the current Interpolation
styles draw curves that intersect existing data points.
None
This is not really an Interpolation Style of the component, but is used when you do not want a
trace line drawn between data points. You simply want to show the known data points on the
graph without a line interconnecting the data points. To draw no line, set the TraceVisible
property to FALSE.
iPlot1.Channel(0).TraceVisible = False
117
Straight Line
This type of interpolation simply draws a straight line between each data point. This can result
in “jagged-looking” curves.
iPlot1.Channel(0).InterpolationStyle = ipistStraightLine
118
Cubic Spline
This type of interpolation draws a curve based on Cubic Spline curve fitting interpolation
equations.
iPlot1.Channel(0).InterpolationStyle = ipistCubicSpline
119
Polynomial
This type of interpolation draws a curve based on Polynomial Interpolation curve fitting
equations and is only good for small data sets (~100 data points)
Polynomial degree is fixed at [n – 1] with n =number of data points.
iPlot1.Channel(0).InterpolationStyle = ipistPolynomial
120
Rational
This type of interpolation draws a curve based on Rational Interpolation curve fitting equations.
This is an alternative to the Polynomial Interpolation with functions that have poles. This
interpolation is good for small to medium-sized data sets.
iPlot1.Channel(0).InterpolationStyle = ipistRational
Sometimes when using the curve fitting styles, an exception may be generated
by the curve-fitting function due to the data being outside of the bounds of the
function. If the data in your channel causes the function to go outside its
bounds (e.g. causes the function to divide by zero or generate a larger number
than can be handled by a double value), then an exception will be generated
within the component causing the painting routine to fail. This will result in
partially drawn curves and/or data points.
121
Differential
This type of interpolation draws a curve based on Differential Interpolation. This style draws
horizontal and vertical lines between data points. A line is drawn horizontal between one point’s
X and Y-Value to the next data point’s X-Value. A vertical line is then drawn perpendicular
from the end point up or down to the Y-Value of the second data point.
iPlot1.Channel(0).InterpolationStyle = ipistDifferential
122
Chapter 19 - Loading and Saving Data
The Plot Pack components support several different methods for storing and retrieving data and control
image snapshots both to and from the local file system or to and from a network server. Additionally,
several data text, data log, and binary image file formats are also supported. The component interfaces
have been left open for future expansion and support of additional file types and formats.
Data Formats
The plot pack components natively support several text formats for saving and loading channel data.
The saved data can be used in other applications (such as Microsoft Excel) or can be used to reload
channel data into another instance of the control at a later date or program execution. Saving and
loading of channel properties, such as channel trace width, line color, and other control properties is
also supported.
There are two interfaces that are supported for loading and saving data. One is specific to a
particular channel and the other is for all channels. To save and load data for a specific channel, use
the methods below from a specific channel interface (e.g. iPlot1.Channel(0).SaveToDataFile).
To save and load data for all channels in the chart, use the methods below from the main plot
component interface (e.g. iPlot1.SaveToDataFile).
The supported data formats are as follows…
•
Text (Tab Delimited) File
SaveDataToFile
This method will save out the data for the specified channel or all channels to a tab delimited text
file specified by FileName.
iPlot1.Channel(0).SaveDataToFile(FileName)
Sample File Output:
0
1
2
0
1
2
9
0
1
2
0
1
2
9
123
iPlot1.SaveDataToFile(FileName)
Sample File Output:
Channel 1(X)
1
2
3
4
6
7
8
9
11
12
13
14
Channel 1(Y)
5
10.458
12.444
6.411
11.558
11.132
9.933
7.983
24.529
5.405
5.433
18.013
Channel 2(X)
0
1
2
3
4
5
6
7
8
9
10
11
Channel 2(Y)
Null
30.627
43.433
38.513
46.817
48.345
43.953
33.252
46.513
47.486
Null
39.85
LoadDataFromFile
This method will load in the data for the specified channel from a tab delimited text file specified
by FileName. The first column must be the X channel data and the second column must be the Y
channel data.
For loading data from the main plot interface, the first column is for the first channel’s X data,
the second column is for the first channel’s Y data, the third column is for the second channel’s
X data, the fourth column is for the second channel’s Y data, and so on. The first row is ignored
when loading data from the main plot interface.
iPlot1.Channel(0).LoadDataFromFile(FileName)
iPlot1.LoadDataFromFile(FileName)
This method will save out the properties for the specified channel to a tab delimited text file
specified by FileName. Note, the file contains property information about the specified channel
or all channels such as trace line width, line color, marker setup information, etc and does not
contain XY data. The properties that are streamed out are generally only used with the
LoadPropertiesFromFile method and not with external applications. Note the main interface’s
SavePropertiesToFile method will stream out all properties of the control, not just the individual
properties for each channel.
iPlot1.Channel(0).SavePropertiesToFile(FileName)
iPlot1.SavePropertiesToFile(FileName)
124
This method will load in the properties for the specified channel from a text file specified by
FileName. Note, the file contains property information about the specified channel or all
channels such as trace line width, line color, marker setup information, etc and does not contain
XY data. The properties that are streamed in are generally only used with the
SavePropertiesToFile method and not with external applications. Note the main interface’s
LoadPropertiesFromFile method will stream in all properties of the control, not just the
individual properties for each channel.
iPlot1.Channel(0).LoadPropertiesFromFile(FileName)
iPlot1.LoadPropertiesFromFile(FileName)
Data Log Formats
The Plot Pack components also support real-time logging of channel data to a text file on your local
hard drive. This differs from the Data Formats above in that data is appended to a text file (Tab
Delimited) as data is being added to the chart.
!
You will need to ensure that the directory specified has already been
created on the target data storage area before activating the log.
LogFileName
This property specifies the path and filename of the log. If you are developing for a crossplatform application, then you will need to ensure that the path and filename are appropriate for
all OS file systems or for the target OS file systems.
iPlot1.Channel(0).LogFileName = FileName
LogBufferSize
This property specifies the size of the buffer to use when logging channel data to the file
specified by the LogFileName property. When data from the chart has filled the buffer, the
buffered data is then written to the log file. This is useful if you want to spread out the disk write
access by the plot component. (i.e. if you don’t use a buffer, then a write to the log is executed
after every data point is added. This may not be desirable in some situations. With the buffer
size set, you can have the component only write to the log after a specified amount of data has
filled the buffer, therefore reducing the number of writes to the log file). The value specified is
in units of # of data points.
125
iPlot1.Channel(0).LogBufferSize = 10
Note that if you are using the log from the main interface, you will be writing out a log file that contains
data for all channels. You must use the AddDataArray method to add data from the main interface if
you are using the main interface logging feature.
LogActivate
This method will start the logging of new data points to the specified file. Note that older data
points will not be added to the log file, only new ones that have been added after executing this
method.
iPlot1.Channel(0).LogActivate
LogDeactivate
This property will stop the logging of new data points to the specified log file.
iPlot1.Channel(0).LogDeactivate
AddDataArray Example
If you are using the logging feature from the main plot interface where you are logging all
channels to a single log file, you have to use the AddDataArray method to add data to the
channels. The first parameter refers to the common X Value for all of the channels, and the array
contains one Y Value for each channel. The array type can be double or any variant type that
can be converted to a double. The following example shows how to add data to the chart.
'Random Data
dim TempArray(100) as Double
for x = 0 to 99
TempArray(x) = rnd(1)*100
next x
iPlot1.AddDataArray(XValue, TempArray)
'Data From Some Other Source
dim TempArray(100) as Double
for x = 0 to 99
TempArray(x) = YValueSource
next x
iPlot1.AddDataArray(XValue, TempArray)
'Your Data is already in array format
iPlot1.AddDataArray(XValue, YValuesArray)
Also refer to the Adding Data Chapter for more information on using AddDataArray, about
using AddDataArray in pseudo-Asynchronous mode, or for handling null or empty value data.
126
Image Formats
There are also several image formats that are supported for saving static images of the plot
component (except for the toolbar object). This is useful for exporting the image for use in an
external reporting tool, for dynamic creation of images for ASP web pages, or for other uses where
you need a “snapshot” graphic of the chart. Supported image formats are as follows…
•
•
•
•
Enhanced Metafile Format (EMF)
Windows/OS2 Bitmap (BMP, RGB Encoded)
Independent JPEG Group Format (JPEG, JPG)
Portable Network Graphics Format (PNG, 16 million colors) {Coming Soon…}
Also See Chapter on Graphic Export.
127
Chapter 20 - Graphical Export
There are also several image formats that are supported for saving static images of the plot component
(except for the toolbar object). This is useful for exporting the image for use in an external reporting
tool, for dynamic creation of images for ASP web pages, or for other uses where you need a “snapshot”
graphic of the chart. Supported image formats are as follows…
•
•
•
•
Enhanced Metafile Format (EMF)
Windows/OS2 Bitmap (BMP, RGB Encoded)
Independent JPEG Group Format (JPEG, JPG)
Portable Network Graphics Format (PNG, 16 million colors) {Coming Soon…}
Enhanced MetaFileFormat
This format is compact, and allows resizing in another application. This file type is only supported
on Windows platforms and is not supported under Linux. We recommend that you use TrueType
fonts (Vector Fonts) in the Plot component when using this file format since TrueType fonts resize
better than bitmap-based fonts.
iComponent.SaveImageToMetaFile(Filename)
iComponent.SaveImageToMetaFile("c:\my documents\plotimage001.emf")
Bitmap
This format is generally used where you need to use a Windows-OS/2 compatible bitmap file. The
file is uncompressed, so it is generally not recommended since other, compressed formats are
available.
iComponent.SaveImageToBitmap(Filename)
iComponent.SaveImageToBitmap("c:\my documents\plotimage001.bmp")
JPEG
This format is compact, lossy compressed, and is widely supported. However, we recommend that
you use our EMF or PNG file types if possible since they produce smaller file sizes and the final
graphic output is more suited for these other formats.
iComponent.SaveImageToJPEG(Filename, Compression, Progressive)
iComponent.SaveImageToJPEG("c:\my documents\plotimage001.emf", 100, True)
Note: Compression is a value between 0-100 and reflects the amount of lossy compression applied
to the image. A value of 25 will give very good compression, but the image will be degraded. We
recommend that you always use a value of 100. Progressive refers to the interlacing encoding used
in some browsers.
128
PNG
This format is compact, loss-less compressed (same quality as a bitmap, no loss of quality), and is
widely supported. This file format is a replacement for the GIF standard (which is encumbered with
patent issues, only supports 256 colors, and doesn’t compress as well as PNG), and is supported by
all version 4.0 web browsers and above on all platforms.
…Note, this format is not yet available…
GetBytesJPEG Method
This method is useful in ASP web pages where you want to send a JPEG image of the Plot
component to a web client. GetBytesJPEG allows you to send a JPEG image directly to the web
client without using intermediate files.
Microsoft IIS Server ASP Page (VBScript)
<%@ Language=VBScript %>

<%
'Setup Response
Response.Expires = 0
Response.Buffer = True
Response.Clear
'Create ActiveX Control
Set iPlotX1 = Server.CreateObject("iPlotLibrary.iPlotX")
'Set Some Properties
iPlotX1.Width=500
iPlotX1.Height=300
iPlotX1.Labels(0).Caption = "Test Chart 1"
iPlotX1.ToolBar(0).Visible = False
'Plot Some Random Data
for x = 0 to 100
iPlotX1.Channel(0).AddXY x, sin(x) * 100
next
'Stream JPEG Image
Response.ContentType = "image/jpeg"
Response.BinaryWrite(iPlotX1.GetBytesJPEG(100, TRUE))
'Cleanup
Set iPlotX1 = Nothing
%>
129
Chapter 21 - Printing
The Iocomp Plot Pack components have built-in, basic capabilities for printing copies of your chart to a
local or network printer. Features include…
1. Ability to show or hide standard printer dialog before print
2. Set Page Orientation
3. Setup Page Margins
When you print out a copy of your chart, the entire image of the chart will be printed except for the
toolbar, and the chart will be expanded to fit the entire page depending on your page orientation and
page margin settings. The printing support in the Plot Pack components is designed to provide a very
simple and easy to use interface for outputting your charts to paper. If you need more complex reporting
capabilities, you will need to use a reporting package or custom code.
Printing Options
Page Orientation
To specify the orientation of the chart to be printed, modify the PrinterOrientation property..
iComponent1.PrinterOrientation = poPortriat
…or…
iComponent1.PrinterOrientation = poLandacape
Printer Dialog
To specify that the standard print dialog is displayed when the Print method is executed, then set
the PrintShowDialog property to TRUE.
iComponent1.PrintShowDialog = TRUE
130
Margins
To set the paper margins, set the following properties to the margins you require. Units are in
inches…
iComponent1.PrintMarginRight
iComponent1.PrintMarginLeft
iComponent1.PrintMarginTop
iComponent1.PrintMarginBottom
=
=
=
=
10
10
10
10
Top Margin
Left Margin
Chart Sizes to fill
entire page inside of
specified margins
Right Margin
Bottom Margin
Simple Chart Print
To print out a copy of the currently displayed chart in your program, execute the following method
on the control…
iPlot1.Print()
This method will print a copy of the current chart, stretched to the size of the page up to the margin
properties that were previously set without the toolbar.
Using with External Reporting Packages or Custom Code
If you require more complex printing options, then you will need to use an external reporting
package or your own customized code. For these other options, you can access a copy of the chart
image for use as follows…
131
Clipboard Transfer
iComponent1.CopyToClipBoard()
This method will copy an enhanced metafile version of the chart to the standard clipboard for use
elsewhere in your program.
Note: use this option carefully. This method will be using your clipboard, and there is a
possibility that other applications or even your application may be using the clipboard at the
same time.
IPictureDisp Object Transfer
Image1.Picture = iComponent1.GetSnapShotPicture()
This method will return an IPictureDisp object image formatted as a metafile.
Save to Enhanced Metafile
iComponent1.Save()
This method will save a copy of the chart image to an enhanced metafile format file for use
elsewhere.
Printing Tips
Many programmers like to see dark background charts with light colored channels and channel
markers when viewing the Plot Components in a program. However, this color scheme doesn’t
look very good on a printout and can waste printer toner, ink, and can lead to wrinkled paper on
inkjet printers.
To counteract these printing issues, it is best to change the colors used in the chart just before
printing, print out the chart, and then reset the colors back to their original settings. For example…
iComponent1.BeginUpdate() {Stops painting to the control to reduce flicker}
{Set background colors for Chart and DataView areas to a light color or white}
iComponent1.Print()
{Set background colors back to their original settings}
iComponent1.EndUpdate() {This resumes painting to the control}
Always, always, always use TrueType fonts to get the best results when saving to a
graphic format or when printing. When using non-TrueType fonts, you may see
distorted fonts or incorrect kerning.
132
Chapter 22 - AutoScale and AutoLabel
All axes support automatic scaling and formatting of their labels and tick marks. The automated scale
(AutoScale feature) refers to the automatic scrolling of the axis with respect to newly added data and is
related to the axis’ tracking feature. The AutoLabel feature refers to the 1-2-5 rules that ensure the
scales look “human readable”, that is to say fall on major ticks and values that look good to a human.
1-2-5 Rule
This rule refers to how the scales label positions and features are automatically calculated by the
component. This means that the component attempts to ensure that the scale contains major tick
labels increment by 1, 2, or 5 (or multiples such as 10, 100, 1000, etc) within the bounds that you
setup using the Axis’ Min and Max properties. In short, the scale will attempt to fit in as many
major tick labels as possible
For example, if your scale goes from –500 to +500, the component will attempt to fit as many
labels between –500 and + 500 that are increment by 1, 2, or 5 and so on. For example, -500, 400, -300, -200, -100, 0, 100, 200, 300, 400, 500 is a possible listing of major ticks in such as
scale that would satisfy the 1-2-5 rule. Another example is –500, -250, 0, 250, 500. An example
that wouldn’t fit would be –500, -389, -278, -167, -56, 56, 167, 278, 389, 500. Besides, that kind
of scale doesn’t look “human readable”
Which scale is used depends on the font size specified for the Axis’ labels. The scale will
attempt to fit in a scale with the maximum number of labels possible. How many can fit depends
several configurable factors.
Below you will find a list of rules used for the AutoScale and AutoLabel features. The
component will go thorough the list in order and attempt to fit the maximum number of labels
133
Linear Scale
The scale will attempt to fit the maximum number of labels where the major tick labels
are divisible by 1, 2, or 5.
Date/Time Scale
The scale will attempt to fit the maximum number of labels possible by moving through
the following order starting from Milliseconds and going out to Years. For example, if
generating labels on human-readable minutes is not possible, the scale will automatically
switch to creating labels using hours instead. If that is not possible, it will move on to
days, etc.
Milliseconds: 1, 2, 5, 10, 20, 50, 100, 200, or 500
Seconds: 1, 5, 10, 15, or 30
Minutes: 1, 5, 10, 15, or 30
Hours: 1, 2, or 12
Days: 1, 7, or 14
Months: 1, 2, 3, or 6
Years: 1, 2, or 5
134
Price32nds Scale
The scale will attempt to fit the maximum number of labels possible where the major
ticks are divisible by...
1/256, 2/256, 4/256, 1/32, 2/32, 4/32, 8/32, or 16/32
Log10 Scale
The scale will attempt to fit the maximum number of labels possible where the major
ticks are divisible by...
2, 5, 10, 20, 50, 100, or 200
135
Modifying the 1-2-5 Rule
DesiredIncrement
If the 1-2-5 Rule doesn’t work in your particular situation, you can “tune” the AutoLabel
feature by using the DesiredIncrement property of the axis. This property let’s you
override the 1-2-5 rule and specify the increment used in the AutoLabel calculations
For example, let’s say you have a scale from 0 to 10. The Scale automatically creates a
scale 0, 2.0, 4.0, 6.0, 8.0, 10.0.
But, you want the scale to increment by values of 2.5. So you would set the
DesiredIncrement property to “2.5”, and if the new scale will fit in the space allotted,
you would see a scale: 0, 2.5, 5.0, 7.5, 10.0.
For scales that do not scroll, you can also specify a fixed DesiredStart property to force
the scale to start the first major tick at a specified value.
136
Desired Start
You can also force the AutoScale routine to start on a particular major tick value instead
of the default Min value of the axis. Let’s say, for example you have a scale from 0 to
10. The initial chart starts the scale off at the minimum value of the scale which is 0.0…
But, you want the first major tick to start off at 0.5. So you would set the DesiredStart
property to 0.5, forcing the scale to start at 0.5…
Tracking
Tracking refers to how the scale reacts when new data is added to the chart, such as smoothly
scrolling to show new data that is added. Refer to the chapter on Tracking for more information.
137
Chapter 23 - Visual C++ Disp vs. iDispatch Interface
Visual C++ supports two different types of ways to interface with an ActiveX component...
Disp Interface [Late Binding]
This is the type of interface that is used if you add an ActiveX component to your project and use
member variables to access your component. This type of interface is slower than the iDispatch
interface, and is not recommended for our Plot Components.
Disp Coding Example
//Using the Disp Interface
Index = m_iPlotX1.AddChannel();
m_iPlotX1.GetChannel(Index).SetMarkersStyle(4); //ipmsPlus
m_iPlotX1.GetChannel(Index).SetTraceLineWidth(2);
m_iPlotX1.GetChannel(Index).AddXY(XValue, YValue);
Sample data rates for our iPlotX component running on an AMD 900Mhz
computer showing the speed differences between the Disp and iDispatch
interface speed. One million data points were plotted on the chart, and the time
taken to perform the plot was recorded below…
• Disp Interface, AddXY Method: 85,000 data points/second
• Disp Interface, AddXYArrays Method: 560,000 data points/second
• iDispatch Interface, AddXY Method: 1,256,000 data points/second
• iDispatch Interface, AddXYArrays Method: 516,000 data points/second
138
iDispatch Interface [Early Binding]
This is the type of interface that is used if you add an ActiveX component to your form (by rightclicking on the form and selecting “Insert ActiveX Control”) or when you create an ActiveX
component dynamically at runtime. This interface is used with your use the #import directive in
your project to dynamically import the TLB during compilation.
The iDispatch Interface is much faster when accessing methods and properties of the Plot Pack
component and is the recommended interface for using our components. Also, accessing subobjects of the components such as channels is much easier and you are able to use the namespace
of the components to access enumerated properties.
iDispatch Coding Example
//Using the iDispatch Interface
Index = iPlotX1.AddChannel();
iPlotX1->Channel[Index].MarkersStyle = ipmsPlus;
iPlotX1->Channel[Index].TraceLineWidth = 2;
iPlotX1->Channel[Index].AddXY(XValue, YValue);
For example, to use the iDispatch Interface, do the following...
1. Insert an ActiveX component onto your form by right clicking on the form and selecting “Insert
ActiveX Component.”
2.
Place the following code at the top of your form’s CPP file...
extern
CComModule _Module;
139
3.
To access the component placed on the form (we named the IDC of the component in this
example “IDC_IPLOTX1”, refer to the following example. This example uses a local variable to
access the component, but you can easily use a global variable instead.
double XData;
double YData;
CWnd*
m_Wnd;
m_Wnd
(LPVOID*)&iPlotX1);
4. Now to access the component, use the newly created variable “iPlotX1”
5. The syntax of accessing the component is similar to Visual Basic and Borland C++ Builder.
Here are a few examples...
//Disp Interface (Slow Speed)
m_iComponentX1.DataView(0).SetGridShow(TRUE);
m_iComponentX1.XAxis(0).SetMin(100);
m_iComponentX1.YAxis(0).SetSpan(100);
m_iComponentX1.Channel(0).SetName(“Channel 1”);
m_iComponentX1.Legend(0).SetVisible(TRUE);
m_iComponentX1.ToolBar(0).SetShowEditButton(FALSE);
m_iComponentX1.Annotation(0).SetText(“Sample Annotation”);
m_iComponentX1.DataCursor(0).SetStyle(3); //ipcsDeltaX
m_iComponentX1.Limit(0).SetXAxisName(“X-Axis 1”);
m_iComponentX1.Labels(0).SetCaption(“Chart Y vs. Time”);
//iDispatch Interface (High-Speed)
iComponentX1->DataView[0]->GridShow
iComponentX1->XAxis[0]->Min
iComponentX1->YAxis[0]->Span
iComponentX1->Channel[0]->Name
iComponentX1->Legend[0]->Visible
iComponentX1->ToolBar[0]->ShowEditButton
iComponentX1->Annotation[0]->Text
iComponentX1->DataCursor[0]->Style
iComponentX1->Limit[0]->XAxisName
iComponentX1->Labels[0]->Caption
=
=
=
=
=
=
=
=
=
=
TRUE;
100;
100;
“Channel 1”;
TRUE;
FALSE;
“Sample Annotation”;
ipcsDeltaX;
“X-Axis 1”;
“Chart Y vs. Time”;
6. Notice that you no longer have to use get and set methods to access properties or to access sub
objects. Simply use the properties as you would in Visual Basic.
7. Since we are using the namespace for the iPlotLibrary, you can also use enumerated properties,
such as “ipcsDeltaX” in the example above.
140
Chapter 24 - Using With Database
Adding data to the Plot Pack component chart from a database is straightforward. Simply loop through
the data in your recordset and add a data point from each record into the chart. The following issues
should be kept in mind to increase performance or to perform more complex swapping of data.
Integrated Text File Saving and Loading
The Plot Pack components natively support loading and saving of data from tab delimited text files
on a per channel or per chart basis. Refer to the chapter entitled “Loading and Saving Data”.
Simple X and Y Data
To add simple integer or double (floating point) data from your database to the chart, simply load
your database recordset, and then loop through each record, adding each X and Y data point by using
the AddData method (by passing X and Y values in double format)…
'Create Database Connection and Recordset
'Loop through recordset until EOF
iPlot1.Channel(0).AddXY RecordFieldXValue, RecordFieldYValue
'End Loop
Time/Date X and Y Data
To add Time or Date Based data from a database, you will first need to convert the value from its
original format to a Double format before adding it to the chart if it is not already in Double format.
(i.e. if the data is in string format as ‘March 1, 2001’ then it will need to be converted to it’s
corresponding Date/Time double format value. For more information about Date/Time formats see
the chapter entitled “Adding Data”)
Many development environments have functions that automate this procedure. For example, if the X
value in the Database is a Time or Date value then you use the following…
'Create Database Connection and Recordset
'Loop through recordset until EOF
DoubleFormatXValue = DateValue(RecordFieldXValue)
iPlot1.Channel(0).AddXY DoubleFormatXValue, RecordFieldYValue
'End Loop
Don’t forget that if you are using Date/Time format values, you need to setup the
associated axis to use DateTime formatted labels. Refer to the chapter entitled
“Adding Data” for more information about DateTime format.
iPlot1.XAxis(0).LabelsFormatStyle = iptfDateTime
iPlot1.YAxis(0).LabelsFormatStyle = iptfDateTime
141
Adding Very Large Amounts of Data to The Chart
If you plan on adding very large amounts of data to the chart (millions of data points or more), then
you have to take into account the memory limits of Windows Applications (2GB per application and
associated components), network speed to transfer large amounts of data, and the processing time
needed to move the data through memory or from a database located on your local hard drive or over
a network.
•
•
•
•
•
1,000,000 data points = 22.35 MB of memory storage
25,000,000 data points = 558.75MB of memory storage
50,000,000 data points = 1.09 GB of memory storage
If you try and load all of this data at once, you will overload the PCI system bus or Ethernet Network
since this is a huge amount of data to move at one time. You may want to consider loading the data
dynamically as needed instead of trying to load all of the data at once.
Also see the chapter entitled “Memory Utilization” for more information.
142
Chapter 25 - Layout Control Through Code
Generally, you will use the built-in property editor to setup and layout objects (layout objects plot
objects such as the axes, data view, toolbar, and legend). Review the chapter entitled “Visual Layout
Manger” for more information. You can, however, modify the placement of layout objects in your
program’s code at run-time by using the following methods and properties.
Layout Manager
The layout manager automatically adjusts the position of layout objects such as the axes, toolbar,
and legend for you. If you are manually adjusting the layout of layout objects through code, it is
helpful to disable the layout manager while you are making changes and then re-enable the layout
manager when you are finished.
To Disable the Layout Manager, execute the following…
iPlot1.DisableLayoutManager
To Enable the Layout Manager, execute the following…
iPlot1.EnableLayoutManager
Layout Object ZOrder
The ZOrder of a plot object determines how it is displayed in relation of other plot objects of the
same type. Each plot object has a ZOrder property that determines how the layout object is painted
on the control in relation to other layout objects. If two layout objects of the same type have the
same ZOrder, then they are considered to be “stacked”.
For example, Y-Axis 1 & 2 have the same ZOrder, so they take up the same vertical position and are
therefore “stacked”…
YAxis 2
YAxis 0
Stacked Axes
YAxis 1
ZOrder 0
ZOrder 1
143
Layout Object StartPercent and StopPercent
To specify how much area a particular layout object takes up, you will need to set the Start and
Stop Percent properties. These properties are currently only supported by the X-Axis, Y-Axis,
and Label objects.
A Start percent of 25% for a vertical layout object means that the layout object begins drawing
25% from the bottom of the area reserved for the axes. A Start percent of 25% for a horizontal
layout object means that the layout object begins drawing 25% from the left side of the
component.
A Stop percent of 75% for a vertical layout object means that the layout object ends drawing
75% from the bottom of the area reserved for the axes. A Stop percent of 75% for a horizontal
layout object means that the layout object ends drawing 75% from the left side of the component.
Horizontal Layout Object
iPlot1.XAxis(0).StartPercent = 25
iPlot1.XAxis(0).StopPercent = 75
25%
75%
0%
100%
Vertical Layout Object
iPlot1.YAxis(0).StartPercent = 25
iPlot1.YAxis(0).StopPercent = 75
100%
75%
25%
0%
144
DataViewZVert and DataViewZHorz
Since the DataView is both a horizontal and vertical layout object, you need to use these
properties off of the main plot component interface to set the relative ZOrder position of the
DataView in relation to other horizontal and vertical layout objects.
DataViewZVert
To place the DataView in ZOrder #2 relative to other vertical layout objects, you would set the
DataViewZVert property equal to 2.
iPlot1.DataViewZVert = 2
YAxis 2
YAxis 0
Data View
YAxis 3
ZOrder 2
ZOrder 3
YAxis 1
ZOrder 0
ZOrder 1
DataViewZHorz
To place the DataView in ZOrder #1 relative to other horizontal layout objects, you would set
the DataViewZHorz property equal to 1.
iPlot1.DataViewZHorz = 1
ZOrder 2
XAxis 1
ZOrder 1
Data View
ZOrder 0
XAxis 0
145
Toolbar and Legend
Currently the Visual Layout Manager in the property editor does not support changing the ZOrder of
the Toolbar. You can however change the ZOrder of the Toolbar relative to other horizontal layout
objects (such as the DataView or X-Axes) by changing the ZOrder of the Toolbar through code at
run-time. Note: this feature is not yet fully supported for positions other than the top of the
component. The toolbar must always be the topmost ZOrder (i.e. the ZOrder must always be greater
than other horizontal layout objects).
The Visual Layout Manager does support changing the ZOrder of the Legend in a graphical manner.
You can also change the ZOrder of the Legend relative to other vertical layout objects (such as the
DataView or Y-Axes) by changing the ZOrder of the Legend through code at run-time. The
following would place the legend at the left side of the component…
iPlot1.Legend(0).ZOrder = 0
!
Only one toolbar and one legend are supported at this time. Always use an
index value of 0 when accessing the ToolBar or Legend.
X and Y-Axes
The plot component axes are designed to automatically take care of drawing, aligning, and maintain
the layout of the axes for you. You do, however, have control over several parameters that affect
how the automated layout is handled.
StackingEndsMargin
Use StackingEndsMargin to get or set the margin at the end of the axis when stacked.
StackingEndsMargin represents the percentage of a character size and is based on the LabelFont
used for the axis. A value of 0.5 is equal to half the size of a character.
Note that this feature currently only supports the Axes layout objects. Also note that the stacking
margin only applies to layout objects that touch each other and only affects the ends that touch.
In the following example, the first Y-Axis (on the bottom) has a starting percent of 0 and ending
percent of 50. The second Y-Axis (on top) has a starting percent of 50 and an ending percent of
100. The Stacking Ends Margin allocates additional space to separate the two stacked axes. The
total spacing is 0.5 characters in this example, with the StackingEndsMargin values being
cumulative. The StackingEndsMargin will have no effect on the ends of the ends of the axes
unless they touch another axis
146
= 0
= 50
= 0.25
= 50
= 100
iPlot1.YAxis(1).StackingEndsMargin = 0.25
100%
50%
0%
StackingEndsMargin
(0.5 = 0.25 + 0.25)
Layout Object Horizontal
This property should not be modified by the developer and is for internal use by the component to
manage the layout and rotation of layout objects. To rotate the X and Y-Axes, use the
XYAxesReverse property off of the main plot component interface…
iPlot1.XYAxesReverse = True
All axes margins use units of character widths and heights. This allows
the component to dynamically adjust the scales based upon the font
used instead of using rigid pixel specifications. A value of 0.25 would
be equivalent to size (horizontal or vertical depending on if the margin
relates to a horizontal or vertical margin) of a single character from the
font being used in the layout object.
147
Plot Component Outer Margin
You can change the inner margin of the plot component, thereby creating a margin between the
layout objects and the edge of the component. The margin values are specified in pixels.
The following example sets a 5-pixel margin around the inside of the Plot Component…
iPlot1.OuterMarginLeft
iPlot1.OuterMarginRight
iPlot1.OuterMarginTop
iPlot1.OuterMarginBottom
=
=
=
=
5
5
5
5
'5
'5
'5
'5
Pixel
Pixel
Pixel
Pixel
Margin
Margin
Margin
Margin
OuterMarginTop
OuterMarginLeft
Layout Objects
OuterMarginRight
OuterMarginBottom
148
Full Layout Through Code Eample
The following example demonstrates adding an additional X-Axis and two additional Y-Axes,
moving the X-Axis and Y-Axes by manipulating the ZOrder of all of the appropriate layout
objects, and then adjusting two of the Y-Axes to be stacked. The code assumes you have added
a fairly large iPlot component to your form and you are placing the code in your form load event.
You don’t have to hand-code the layout of objects unless you wish or need to do so.
You can always use the Visual Layout Manager to arrange the layout objects
without using any code in your program. Refer to the chapter entitled “Visual
Layout Manager” for more information about using the Visual Layout Manager..
The output from the program should look like the following…
X-Axis (1)
Y-Axis (0)
Label (0)
Y-Axis (2)
X-Axis (0)
Y-Axis (1)
149
Visual Basic/VBA/VBScript
'Add one additional X-Axis
'There is already one X-Axis in the chart by default
iPlotX1.AddXAxis
'Add two additional Y-Axes
'There is already one Y-Axis in the chart by default
iPlotX1.AddYAxis
iPlotX1.AddYAxis
'Disable the Layout Manager so that it doesn't interfere
'with our manual layout code
iPlotX1.DisableLayoutManager
'Configure ZOrder of Horizontal Layout Objects
iPlotX1.XAxis(0).ZOrder
= 0
iPlotX1.DataViewZHorz
= 1
iPlotX1.XAxis(1).ZOrder
= 2
iPlotX1.Labels(0).ZOrder = 3
iPlotX1.ToolBar(0).ZOrder = 4
'Configure ZOrder of Vertical Layout Objects
'Note that the first two Y-Axes will have the same ZOrder,
'making them stacked axes
iPlotX1.YAxis(0).ZOrder = 0
iPlotX1.DataViewZVert
= 1
iPlotX1.Legend(0).ZOrder = 3
'Configure the Start and Stop
iPlotX1.YAxis(0).StartPercent
iPlotX1.YAxis(0).StopPercent
iPlotX1.YAxis(1).StartPercent
iPlotX1.YAxis(1).StopPercent
Percent of the two Y-Axes we wish to stack
= 0
= 50
= 50
= 100
'Configure the Stacking Ends Margins for each of the stacked axes to allow
'for a separation total of half of a character between the ends of the axes
'that touch each other
iPlotX1.YAxis(0).StackingEndsMargin = 0.25
iPlotX1.YAxis(1).StackingEndsMargin = 0.25
'Assign the Grid to use the Y-Axis on the far right so that the Grid looks
'consistent
iPlotX1.DataView(0).GridYAxisName = iPlotX1.YAxis(2).Name
'Re-Enable the Layout Manager
iPlotX1.EnableLayoutManager
150
Delphi/Kylix
//Add one additional X-Axis
//There is already one X-Axis in the chart by default
iPlot1.AddXAxis;
//Add two additional Y-Axes
//There is already one Y-Axis in the chart by default
iPlot1.AddYAxis;
iPlot1.AddYAxis;
//Disable the Layout Manager so that it doesn't interfere with our manual
//layout code
iPlot1.DisableLayoutManager;
//Configure ZOrder of Horizontal Layout Objects
iPlot1.XAxis[0].ZOrder
:= 0;
iPlot1.DataViewZHorz
:= 1;
iPlot1.XAxis[1].ZOrder
:= 2;
iPlot1.Labels[0].ZOrder
:= 3;
iPlot1.ToolBar[0].ZOrder := 4;
//Configure ZOrder of Vertical Layout Objects
//Note that the first two Y-Axes will have the same ZOrder, making them
//stacked axes
iPlot1.YAxis[0].ZOrder := 0;
iPlot1.DataViewZVert
:= 1;
iPlot1.Legend[0].ZOrder := 3;
//Configure the Start and Stop Percent of the two Y-Axes we wish to stack
iPlot1.YAxis[0].StartPercent := 0;
iPlot1.YAxis[0].StopPercent := 50;
iPlot1.YAxis[1].StartPercent := 50;
iPlot1.YAxis[1].StopPercent := 100;
//Configure the Stacking Ends Margins for each of the stacked axes to allow
//for a separationtotal of half of a character between the endsof the axes
//that touch each other
iPlot1.YAxis[0].StackingEndsMargin := 0.25;
iPlot1.YAxis[1].StackingEndsMargin := 0.25;
//Assign the Grid to use the Y-Axis on the far right so that the Grid looks
//consistent
iPlot1.DataView[0].GridYAxisName := iPlot1.YAxis[2].Name;
//Re-Enable the Layout Manager
iPlot1.EnableLayoutManager;
151
Place the following include statements at the top of your cpp file…
#include
#include
#include
#include
#include
#include
"iplotx.h"
"iplotaxisx.h"
"iplotlegendx.h"
"iplottoolbarx.h"
"iplotdataviewx.h"
"iplotlabels.h"
================================================================
//There is already one X-Axis in the chart by default
m_iPlotX1.AddXAxis();
//There is already one Y-Axis in the chart by default
m_iPlotX1.AddYAxis();
m_iPlotX1.AddYAxis();
//Disable the Layout Manager so it doesn't interfere with manual layout code
m_iPlotX1.DisableLayoutManager();
m_iPlotX1.GetXAxis(0).SetZOrder(0);
m_iPlotX1.SetDataViewZHorz(1);
m_iPlotX1.GetXAxis(1).SetZOrder(2);
m_iPlotX1.GetLabels(0).SetZOrder(3);
m_iPlotX1.GetToolBar(0).SetZOrder(4);
//Configure ZOrder of Vertical Layout Objects. Note that the first two
//Y-Axes will have the same ZOrder, making them stacked axes
m_iPlotX1.GetYAxis(0).SetZOrder(0);
m_iPlotX1.SetDataViewZVert(1);
m_iPlotX1.GetLegend(0).SetZOrder(3);
//Configure the Start and Stop Percent of the two Y-Axes we wish to stack
m_iPlotX1.GetYAxis(0).SetStartPercent(0);
m_iPlotX1.GetYAxis(0).SetStopPercent(50);
m_iPlotX1.GetYAxis(1).SetStartPercent(50);
m_iPlotX1.GetYAxis(1).SetStopPercent(100);
//Configure the Stacking Ends Margins for each
//of the stacked axes to allow for a separation
//total of half of a character between the ends
//of the axes that touch each other
m_iPlotX1.GetYAxis(0).SetStackingEndsMargin(0.25);
m_iPlotX1.GetYAxis(1).SetStackingEndsMargin(0.25);
//Assign the Grid to use the Y-Axis on the far right
//so that the Grid looks consistent
m_iPlotX1.GetDataView(0).SetGridYAxisName(m_iPlotX1.GetYAxis(2).GetName());
m_iPlotX1.EnableLayoutManager();
152
Visual C++ [High-Speed iDispatch Inteface]
Place the following include statements at the top of your file…
extern
CComModule _Module;
================================================================
double XData;
double YData;
CWnd*
m_Wnd;
m_Wnd
(LPVOID*)&iPlotX1);
//There is already one X-Axis in the chart
//by default
iPlotX1->AddXAxis();
//There is already one Y-Axis in the chart
//by default
iPlotX1->AddYAxis();
iPlotX1->AddYAxis();
//Disable the Layout Manager so that
//it doesn't interfere with our manual
//layout code
iPlotX1->DisableLayoutManager();
iPlotX1->XAxis[0]->ZOrder
= 0;
iPlotX1->DataViewZHorz
= 1;
iPlotX1->XAxis[1]->ZOrder
= 2;
iPlotX1->Labels[0]->ZOrder
= 3;
iPlotX1->ToolBar[0]->ZOrder = 4;
//Note that the first two Y-Axes will have the
//same ZOrder, making them stacked axes
iPlotX1->YAxis[0]->ZOrder = 0;
iPlotX1->DataViewZVert
= 1;
iPlotX1->Legend[0]->ZOrder = 3;
//Configure the Start and Stop Percent of the
//two Y-Axes we wish to stack
iPlotX1->YAxis[0]->StartPercent = 0;
153
iPlotX1->YAxis[0]->StopPercent = 50;
iPlotX1->YAxis[1]->StartPercent = 50;
iPlotX1->YAxis[1]->StopPercent = 100;
iPlotX1->YAxis[0]->StackingEndsMargin = 0.25;
iPlotX1->YAxis[1]->StackingEndsMargin = 0.25;
iPlotX1->DataView[0]->GridYAxisName = iPlotX1->YAxis[2]->Name();
iPlotX1->EnableLayoutManager();
154
C++ Builder
//There is already one X-Axis in the chart
//by default
iPlot1->AddXAxis();
//There is already one Y-Axis in the chart
//by default
iPlot1->AddYAxis();
iPlot1->AddYAxis();
//Disable the Layout Manager so that
//it doesn't interfere with our manual
//layout code
iPlot1->DisableLayoutManager();
iPlot1->XAxis[0]->ZOrder
= 0;
iPlot1->DataViewZHorz
= 1;
iPlot1->XAxis[1]->ZOrder
= 2;
iPlot1->Labels[0]->ZOrder = 3;
iPlot1->ToolBar[0]->ZOrder = 4;
//Note that the first two Y-Axes will have the
//same ZOrder, making them stacked axes
iPlot1->YAxis[0]->ZOrder = 0;
iPlot1->DataViewZVert
= 1;
iPlot1->Legend[0]->ZOrder = 3;
//Configure the Start and Stop
//two Y-Axes we wish to stack
iPlot1->YAxis[0]->StartPercent
iPlot1->YAxis[0]->StopPercent
iPlot1->YAxis[1]->StartPercent
iPlot1->YAxis[1]->StopPercent
Percent of the
=
=
=
=
0;
50;
50;
100;
iPlot1->YAxis[0]->StackingEndsMargin = 0.25;
iPlot1->YAxis[1]->StackingEndsMargin = 0.25;
iPlot1->DataView[0]->GridYAxisName = iPlot1->YAxis[2]->Name();
iPlot1->EnableLayoutManager();
155
Chapter 26 - Performance Tuning
By default, the Plot Components are designed to provide real-time performance even at high data rates
on most system and application configurations. However, there are certain limitations and realities of
the Windows and Linux operating systems, as well as graphics and processor hardware considerations.
For example, you will have no problem displaying tens of thousands of data points per second on a chart
on a standard Windows 95/98/ME/NT/2000 or Linux system. However, the operating system can only
draw to the screen at a certain rate depending on your processor speed, video card speed, system load,
and/or the pixel size of the area being drawn on the video display.
Overall Component Speed = (Component Size) * (Frame Rate) * (System Speed)
* (Video Card Speed) * (System Load)
To achieve the best real-time performance with extremely high data rates and frame rates, you will need
to take the following items into consideration when setting up the component and or your computer
system…
Component Size
This is by far the most important item that affects the perceived speed and processor usage on
your system.
For example, when you display a video file on a standard system (high frame rate video, 500Mhz
processor, 64MB Ram, 1024x768 system), you will see the processor usage climb as you
increase the size of the video window. This happens because the operating system has to draw
more pixels to the screen as you increase the size of the window.
This is also the case with components. If you try to run a Plot component at full screen
(1024x768 for example), the operating system has to work harder to draw the increased number
of pixels to the system.
Frame Rate
All of Iocomp’s components include properties and methods that allow you to control how often
the control is repainted when changes are made to the components such as adding data or
scrolling axes. Properties and methods that allow this control are: AutoFrameRate,
UpdateFrameRate, BeginUpdate, and EndUpdate. These features allow you to either
automatically or manually control how often the control’s display area is updated.
156
AutoFrameRate
The AutoFrameRate property specifies whether the control automatically controls the
frame repaint rate. With AutoFrameRate enabled, the control will automatically throttle
the number of repaints per second that the control executes according to the number of
frame per second specified in the UpdateFrameRate property. By using the Auto
Frame Rate feature, you can control the number of repaints that the operating system has
to make for the control, therefore reducing the amount of processing time used by this
component.
iComponent1.AutoFrameRate = TRUE
UpdateFrameRate
The UpdateFrameRate property specifies the frame rate at which the control
automatically repaints in frame per second. Every time a data point is plotted or when a
user scrolls the axes, the control has to repaint itself to reflect the new changes.
iComponent1.UpdateFrameRate = 10
The frame rate is used to improve performance by controlling the number of times the
control repaints itself per second. To activate automatic frame rate control, the
UpdateFrameRate property must be non zero. You can also use the manual
BeginUpdate and EndUpdate method to manually control repainting even if the
UpdateFrameRate feature is turned on.
Each time a change occurs to the control that requires a repaint, the control will
determine if a new frame needs to be displayed. The FrameTime is one second divided by
the UpdateFrameRate. If a change occurs to the control before the FrameTime has
elapsed, the control is not repainted. If a change occurs to the control after the
FrameTime has elapsed, the control is repainted and the next frame is started.
There must be a steady stream of changes to the control that require repainting for the
automatic frame rate control to function correctly. The rate of change per second must be
greater than the UpdateFrameRate for the desired frame rate to be achieved. Once
changes to the control that require repainting have been stopped, call the EndUpdate
method to force the control to repaint the last changes that may be cached.
When the frame rate control is inactive, the control will attempt to repaint when a change
is made to the control that requires a repaint. The actual number of repaints per second is
dependent of the system hardware, system activity, and the number of request being
made to repaint the control.
The frame rate can be manually controlled by using the BeginUpdate and EndUpdate
methods. Make sure that the UpdateFrameRate property is set to 0 to disable automatic
frame rate control. Your code will need to keep track of the last update before beginning
157
a new frame. To begin a new frame, call the EndUpdate method and then the
BeginUpdate method to start the next frame.
Note: if the user is interacting with the component, such as scrolling axes, clicking
toolbar buttons, etc, the UpdateFrameRate is ignored. This allows the control to repaint
quickly when the user is using the UI of the component so that it doesn’t appear sluggish
with very slow Update Rates.
BeginUpdate
This method is used to manually stop all painting to the control if needed. This is useful
if you plan on adding a very large amount of data to the chart or wish to make many
changes to the chart, but don’t want the chart to repaint until you have completed your
operations.
iComponent1.BeginUpdate
EndUpdate
This method is used in conjunction with the AutoFrameRate feature mentioned above. It
can also be used to manually resume all painting to the control if needed when
AutoFrameRate is turned off.
iComponent1.EndUpdate
System Hardware
Most modern or new computer systems are easily capable of displaying real-time data to the
video display. If you need to display our controls with very high data rates on large video
displays with large component sizes, then you will need to ensure that your computer hardware is
up to the task.
Processor
Having a faster processor generally will improve overall performance of your system and
will increase the speed of draws to your video screen. Most modern systems
(approximately 400Mhz or higher) have processors fast enough to handle most real-time
applications used with our controls.
158
Memory
The amount of memory is generally not that important to the speed of displaying data to
the screen. The amount of RAM memory only comes into play when you are buffering
many millions of data points into the chart, and have very low amounts of RAM in your
system. If you run out of physical RAM, the operating system has to use the hard disk to
store additional program memory, which is significantly slower than using physical
RAM. See the next chapter regarding Memory Utilization of our Plot Pack components.
Note: Windows NT and 2000 allow you to set specific minimum and maximum sizes for
the virtual memory swap file. If you will be storing may millions of data points in the
chart, ensure that your maximum virtual memory swap file settings are set to
accommodate the expected memory usage.
Video Card
Many computer manufacturers have opted to include video card chipsets into the system
bios/chipset. Generally, these types of video chipsets are not designed for displaying
high-speed data to the video display. Also, some video cards that are included with
systems are similarly not designed for displaying high-speed data.
It is recommended that you use a high quality (many are not expensive), accelerated
video card in your system if you will be using very large component sizes or video
resolutions.
Many people ask about their processor usage being very high when
adding data at very high data rates. Generally this is not a problem
since repaints to the screen have very low priority on the system, and
if other processes need processor time during very heavy system
loads, the repaints will be dropped.
By using the AutoFrameRate feature of our components, you can
reduce the actual processor load on the system due to repaints by our
controls if needed.
Special ActiveX Example:
When iterating through a large loop and access sub objects of the ActiveX plot component, it is
more efficient to create a temporary variable to keep track of the sub object in memory instead of
having to access it during each iteration of the loop.
In the example above, we go through a loop 100 times. We access the channel sub object 100
times for each AddXY method. There is a very small performance penalty when accessing the
159
channel, which is magnified when looping, and can be noticeable with very large loops. To
rectify this, we can sacrifice a small amount of memory to greatly speed up large loops. We will
set a local variable to reference the channel sub-object only once, and then reuse the local
variable in the loop.
In the following example we will create a temporary variable to hold the channel sub object and
will loop through 1,000,000 data points. You can flip between the method used in the example
above and the example shown below to see the difference in speed. (Approximately 2x-4x faster
using the local variable method shown below depending on your compiler).
Visual Basic
Private
Dim
Dim
Dim
Dim
x As Long
XData As Double
YData As Double
TempChannel as iPlotChannelX
For x = 1 To 1000000
'Increment X Data
XData = XData + 1
'Plot XY Data Pair
Next x
End Sub
160
#include "iplotx.h"
{
double XData;
double YData;
CiPlotChannelX TempChannel;
XData = 0;
YData = 0;
TempChannel = m_iPlotX1.GetChannel(0);
for(int i=0; i<1000000; i++)
{
//Increment X Data
XData = XData + 1;
//Plot XY Data Pair
TempChannel.AddXY(XData, YData);
};
}
161
extern
CComModule _Module;
{
double XData;
double YData;
CWnd*
m_Wnd;
CComPtr<iPlotLibrary::IiPlotChannelX> tempChannel;
m_Wnd
(LPVOID*)&iPlotX1);
tempChannel = iPlotX1->Channel[0];
XData = 0;
YData = 0;
for(int i=0; i<1000000; i++)
{
//Increment X Data
XData = XData + 1;
//Plot XY Data Pair
tempChannel->AddXY(XData, YData);
};
}
Also see chapter "Visual C++ Disp vs. iDispatch Interface" for more
information about the High-Speed iDispatch Interface.
162
Internet Explorer
<html>
<head>
</head>
<body>
Dim x
Dim XData
Dim YData
Dim TempChannel
For x = 1 To 1000000
XData = XData + 1
'Plot XY Data Pair
Next
end sub
-->
</script>
</body>
</html>
163
Chapter 27 - Memory Utilization
The Plot Pack components include several mechanisms for controlling the amount of RAM memory that
is used to store channel data. By storing all or some of the data for each channel, the plot component
makes it possible to use the built in scrolling, zooming, and cursor tools to be able to look at historical
data and to be able to print and save that data to other formats.
The following sections will discuss how the Plot Pack components store data and how to control the
amount of RAM memory that is used to suit your needs.
Data Storage
Memory Usage Calculations
Since the plot pack components are designed to handle asynchronous data channels (i.e. the data
points from one channel don’t have to be in sync with data points in another channel), each data
point use 2 double values and a Boolean value to represent a single data point
2 doubles and a Boolean value are used to represent one data point.
2 Double Values = 20 bytes (double = 10 bytes)
1 Boolean Value = 4 bytes
Total = 20 + 4 = 24 bytes per data point
Therefore, each data point that you add to the chart takes up 24 bytes of memory.
to add 1 million (1,000,000) data points to your chart, you can expect to use…
If you expect
24 bytes * 1,000,000 = 24,000,000 bytes
24 million bytes / 1024 bytes per KB = 23,437.5 KB
23,437.5 KB / 1024 KB per MB = 22.89 MB for 1,000,000 Data Points
…a total of 22.89 MB for all 1 million data points. If you have 5 channels with 100,000 data
points added to each channel that would be…
24 bytes * 5 channels * 100,000 = 12,000,000 bytes
12 million bytes / 1024 bytes per KB = 11,718.8 KB
11,718.8 KB / 1024 KB per MB = 11.44 MB for 5 channels
…a total of 11.44MB of data storage needed for 5 channels with 100,000 data points each
channel.
Future versions of our Plot Pack will include the capability to specify the data storage style where
you can trade-off functionality of our component for increased number of allowable points to be
stored in the component.
164
2GB Application RAM Barrier
Under the Windows 32-bit operating system, each application is limited to using a total 2GB of
RAM Memory (2048 MB). This includes memory usage by everything in the program,
including variables in your code and memory used by all components in the application
(ActiveX, VCL, or CLX components). Keep this in mind when determining how much data you
can fit into the chart as exceeding the 2GB RAM Usage barrier can result in nasty out of memory
or other program and system errors. If you run into this issue, then either use the Ring Buffer
feature of the Plot Pack, reduce the number of data points added to the chart, or periodically save
the data to an external file and clear out the buffer before adding additional data points. Future
versions of Windows will support larger memory usage sizes. Consult your development
environment documentation and Windows documentation for more information about future
updates to this limitation
Under Linux (CLX components only) the amount of memory accessible by an application
depends on your kernel version, kernel build, and development environment. This can range
between 2GB and 64GB depending on your situation, but is generally a 2GB limit for most
distributions. Consult your development environment documentation and Linux distribution
documentation for more information.
Resource Memory vs. RAM Memory
RAM Memory
Modern operating systems such as Microsoft Windows 95/98/ME/NT/2000 and Linux
support Virtual Memory and can handle the addition of data sets of this size. This means
that in a system with…
•
•
64MB of Physical RAM
128MB of Virtual Memory
…you can support 192 MB of data from the operating system and running applications.
If you are using 1,000,000 data points in your chart (22.89 MB of data), this can easily fit
in your available system RAM memory. If you need additional memory, increase the
allocation of virtual memory (See your System control panel or operating system
documentation) or install additional RAM modules.
Resource Memory
Resource Memory, on the other hand, depends on your operating system and is not
related to the amount of Physical RAM or Virtual Memory you have allocated for your
operating system. Resources refer to memory allocated to brushes, pens, windows, font
managers, and other operating system dependent resources. Operating systems such as
Windows 95/98/ME have a smaller limit on the amount of resources that can be allocated
at any one time compared to Windows NT/2000/XP systems. This is a function of the
165
operating system and does not matter how much RAM you have installed, even if you
have gigabytes of memory installed.
This resource memory barrier limits the number of programs, windows, and controls that
you can have open at any one time. You should have no problem running several Plot
Pack components (Service Pack 1 release or greater) in your application.
You can run approximately 1500 windows + controls on a Windows 95/98/ME system,
and approximately 3000 windows + controls on a Windows NT/2000 system. Windows
XP is expected to have even higher limits. Note that this is highly dependent on other
applications, services, and other programs running on your system and is intended only as
a guide.
Ring Buffer
By default, the plot components store all data that has been added to available system RAM
memory. To control the amount of memory that is used by the charts, you can take advantage of the
Ring Buffer support in the plot components.
The Ring Buffer is a FIFO (First-In First-Out. In other words, when the buffer is full, the first data
point added is the first data point to be overwritten) type buffer where you specify the maximum
amount of data points that can fit in the buffer. Once that maximum number is exceeded, then data
is removed from the buffer starting with the first data points that were initially added.
!
When you set the Ring Buffer to a non-zero value, then memory will be
allocated for that number of data points whether or not those data points
actually exist. The advantage to this type of buffer is that you will always
know if the buffer you have set exceeds the available RAM + Virtual
Memory on your system ahead of time, instead of find this out after running
the chart overnight!
To enable the Ring Buffer for a particular channel, set the RingBufferSize property for the number
of data points that you wish to remain in the buffer for a specific channel.
iPlot1.Channel(0).RingBufferSize = 10000
The RingBufferSize is specified in the number of data points allowed in the
buffer for this particular channel. This property setting does not affect other
channels.
166
To disable the ring buffer and storage all data to available memory (up to the 2GB per application
limit), set the ring buffer property to zero…
iPlot1.Channel(0).RingBufferSize = 0
Oldest Data
Overwritten
[Tail]
Newly Added
Data Points
[Head]
Ring Buffer (FIFO)
167
Chapter 28 - Implementing Toolbar Externally
The built-in toolbar is intended to be a very simple and easy to use toolbar, providing basic user tools
and functionality for the Plot Pack components. If you need a more advanced toolbar, or if you want to
include functionality for other features of your application, you will need to use an external toolbar
control.
The Plot Pack components have interfaces that allow you to easily map and perform the same functions
as the built-in toolbar. Many development environments come with their own toolbar controls and you
can find many other third-party toolbars with many advanced features. You will need to use our toolbar
interfaces in the event code that is generated by the toolbar that you use. Each function interface will
perform the same action as if the user had clicked on the corresponding built-in toolbar button.
Methods that are available to perform toolbar functions are as follows…
Resume Button
iComponent.ToolBar(0).DoButtonClickResume
Pause Button
iComponent.ToolBar(0).DoButtonClickPause
Axes Scroll Mode Button
iComponent.ToolBar(0).DoButtonClickScrollAxesMode
Axes Zoom Mode Button
iComponent.ToolBar(0).DoButtonClickZoomAxesMode
Zoom In Button
iComponent.ToolBar(0).DoButtonClickZoomOut
168
Zoom Out Button
iComponent.ToolBar(0).DoButtonClickZoomIn
Select Button
iComponent.ToolBar(0).DoButtonClickSelect
Zoom Box Button
iComponent.ToolBar(0).DoButtonClickZoomBox
Cursor Button
iComponent.ToolBar(0).DoButtonClickCursor
Edit Button
iComponent.ToolBar(0).DoButtonClickEdit
Copy Button
iComponent.ToolBar(0).DoButtonClickCopy
Save Button
iComponent.ToolBar(0).DoButtonClickSave
Print Button
iComponent.ToolBar(0).DoButtonClickPrint
!
Currently, only one toolbar is supported. Always use ToolBar(0) when referencing
the toolbar. In a future release, the Plot Components will support multiple toolbars.
169
Chapter 29 - Implementing Legend Externally
The built-in legend automatically provides the following functionality…
•
•
•
•
•
•
Channel Trace Line Style and Color Listing
Channel Marker Style and Color Listing
Channel Name Listing
Channel Associated X-Axis
Channel Associated Y-Axis
Channel Current X/Y Coordinate
… if you wish to implement your own legend outside of our component, you can emulate the features
listed above as follows…
Channel Name Listing
The value displayed in the Title column is actually not the ChannelName property, but the
ChannelTitle property. The ChannelTitle property controls what is displayed in the Title column.
To access a particular Channel Title, use the following…
iPlot1.Channel(0).ChannelTitle
…where 0 is the Channel index corresponding to the first channel.
170
To access all of the Channel Titles in a loop, execute the following…
For x = 0 to iPlot1.ChannelCount -1
ChannelTitleTextString = iPlot1.Channel(x).ChannelTitle
Next x
Channel Trace Line Style and Color Listing
The colored line displayed in the first represents the line style and color of the channel’s trace line.
Note that the width of the line is not represented and that the line style is simulated to make it easier
to distinguish among the different line styles available. To access a particular Channel Line Style or
Line Color, use the following…
iPlot1.Channel(0).TraceLineStyle
iPlot1.Channel(0).Color
…where 0 is the Channel index of the 1st channel. The following line styles are available…
Line Style
iplsDash
iplsDashDot
iplsDashDotDot
iplsDot
iplsSolid
Integer Value
0
1
2
3
4
To access all of the Channel Trace Line Styles and Colors in a loop, execute the following…
For x = 0 to iPlot1.ChannelCount -1
ChannelLineStyleValue = iPlot1.Channel(x).TraceLineStyle
ChannelLineColor = iPlot1.Channel(x).Color
ChannelLineStyle = iPlot1.Channel(x).TraceLineStyle
Next x
Channel Trace Line
Channel Marker
171
Channel Marker Style and Color Listing
The colored marker displayed in the first represents the marker style and color of the channel’s
marker. There are several properties that affect the look of a Channel Marker. A marker is drawn
using a style to determine the shape of the marker, a pen (for drawing the outline), and a brush (for
drawing the “fill”). To access the properties of markers for a particular channel, use the following…
iPlot1.Channel(0).MarkersBrushColor
iPlot1.Channel(0).MarkersBrushStyle
iPlot1.Channel(0).MarkersBrushUseChannelColor
iPlot1.Channel(0).MarkersPenColor
iPlot1.Channel(0).MarkersPenStyle
iPlot1.Channel(0).MarkersPenUseChannelColor
iPlot1.Channel(0).MarkersPenWidth
iPlot1.Channel(0).MarkersSize
iPlot1.Channel(0).MarkersStyle
…where 0 is the Channel index corresponding to the first channel. The following marker styles,
brush styles are line styles are available…
Markers Style
ipmsCircle
ipmsSquare
ipmsDiamond
ipmsCross
ipmsPlus
ipmsTriangleUp
ipmsTriangleDown
ipmsTriangleLeft
ipmsTriangleRight
172
Integer Value
0
1
2
3
4
5
6
7
8
Brush Style
bsSolid
bsClear
bsHorizontal
bsVertical
bsFDiagonal
bsBDiagonal
bsCross
bsDiagCross
Integer Value
0
1
2
3
4
5
6
7
Pen Style
psSolid
psDash
psDot
psDashDot
psDashDotDot
psClear
Integer Value
0
1
2
3
4
5
Channel Associated X-Axis
To obtain the associated X-Axis for a particular channel, use the following…
iPlot1.Channel(0).XAxisName
Channel Associated Y-Axis
To obtain the associated Y-Axis for a particular channel, use the following…
iPlot1.Channel(0).YAxisName
Channel Current X/Y Coordinate
The X and Y columns in the legend display the current X and Y coordinates for the most recently
added data point for a particular channel. In the example below, the green channel (Channel 6)
shows a current Y value of 30, which corresponds to the X-Value displayed in the graph and in
the legend.
To access any particular X or Y coordinate of a particular data point, use the following where
Index is the index of the data point being requested (0 would be the first data point, 1 the second,
2 the third, etc.)…
XValue = iPlot1.Channel(0).DataX(Index)
YValue = iPlot1.Channel(0).DataY(Index)
To access the X and Y coordinate of the most recently added data point, use the following…
XValue = iPlot1.Channel(0).DataX(iPlot1.Channel(0).Count – 1)
Yvalue = iPlot1.Channel(0).DataY(iPlot1.Channel(0).Count – 1)
173
Chapter 30 - ASP (Active Server Pages)
Chapter 30 - ASP (Active Server Pages)
Working with ASP pages in conjunction with a Microsoft IIS server (Windows NT 4.0, Windows 2000,
Windows XP) allows you to instantiate our component on the server side, add data to the chart, and then
stream an image of the chart to your end user without using temporary files. This is all done without
needing to run a copy of our component on the web browser client, allowing for cross-platform support
of our component in static mode.
Here is a simple example that shows how to create a Plot component on the web server, set some
properties of the component, add some data, and then stream out a JPEG image of the component to
your client by using the Response object. ASP Page code is interpreted on the web server before it is
sent to the client, so the following script would be replaced with a JPEG image in the resulting HTML
code sent to the browser.
Microsoft IIS Server ASP Page (VBScript)
<%@ Language=VBScript %>

<%
'Setup Response
Response.Expires = 0
Response.Buffer = True
Response.Clear
'Create ActiveX Control
Set iPlotX1 = Server.CreateObject("iPlotLibrary.iPlotX")
'Set Some Properties
iPlotX1.Width=500
iPlotX1.Height=300
iPlotX1.Labels(0).Caption = "Test Chart 1"
iPlotX1.ToolBar(0).Visible = False
'Plot Some Random Data
for x = 0 to 100
iPlotX1.Channel(0).AddXY x, sin(x) * 100
next
'Stream JPEG Image
Response.ContentType = "image/jpeg"
Response.BinaryWrite(iPlotX1.GetBytesJPEG(100, TRUE))
'Cleanup
Set iPlotX1 = Nothing
%>
174
Chapter 31 - Internet Explorer (Client Side)
Our ActiveX version of our Plot Pack components can be used to display Real-Time chart data in the
Microsoft Internet Explorer Browser. This chapter covers running our Plot Pack ActiveX components
on a client’s Internet Explorer Browser. If you only require static images to be displayed on a users
machine and you wish to support all operating systems and browsers other than Microsoft Internet
Explorer and Windows, then please refer to our chapter on ASP (Active Server Pages) and/or Apache
Web Modules.
The following requirements must be met to be able to display Real-Time data from your network server
to your local client’s web browser…
1. The client must be running 32-bit Windows.
2. The client must be running Microsoft Internet Explorer 3.01 or higher version
3. You must provide code or another ActiveX component in your HTML webpage code to transfer
data from the web server or other network server or computer. If your web page will be
acquiring data from the client’s machine or if you will be statically embedding your data in the
web page (or statically through ASP or other server side scripts), then this is not needed. SOAP
as well as direct database-linking support will be provided in a future release.
!
Netscape and The Mozilla project do have solutions for embedding ActiveX
controls in their browsers on Windows machines with varying degrees of
success. Some solutions support properties and events, others do not. Iocomp
does not support these solutions at this time, but will support future versions
of Netscape, Mozilla, and other browsers when they attain sufficient support
for embedding ActiveX controls.
Creating the Plot Pack ActiveX Object in Your Web Page
To create an ActiveX object on the client’s machine, you would need to include the following html
code in the body section of your web page…
width="500" height="200">
</object>
Many HTML development tools such as InterDev and FrontPage will automatically generate this
code for you, and will also stream out design-time properties of the control to the html document for
you. If you are using an HTML development tool that doesn’t automatically generate this code for
you, you will need to manually type in the information as needed.
175
ClassID List for Plot Pack Components
iPlot
1791C036-8981-492A-BD28-F2331BC9B7C7
iXYPlot
D1CAE8F4-6DFF-4187-B1B8-DDCF91F98A8A
Refer to Appended <Insert Appendix Number Here>: ActiveX HTML Properties and Events for a
listing of all of the supported properties and events than can be used with our Plot Pack components
in an HTML web page.
Installing the Plot Pack ActiveX Control on the Client
To automatically install and update our Plot Pack ActiveX controls on your client machine, you will
need to modify the “object” tag used in the previous section as follows…
<object classid="clsid:1791C036-8981-492A-BD28-F2331BC9B7C7" id="iPlotX1" width="500"
height="200" codebase="pathname/iPlotLibrary.cab#2,0,0,0">
</object>
The addition of codebase=”pathname/iPlotLibrary.cab#2,0,0,0” instructs Internet Explorer to
download, install, and register the Plot Pack ActiveX components (compressed in a CAB file) under
the following conditions…
1. The Plot Pack ActiveX is not installed on the client’s computer
2. The version of the Plot Pack ActiveX installed on the client’s computer is less than the
version specified after the # symbol. Notice that the version number separator is “,”
and not “.”.
To obtain a digitally signed, pre-prepared CAB file for the Plot Pack or any of our ActiveX
components, navigate to our downloads web page at http://www.iocomp.com/download
To obtain the version number of the ActiveX component contained in our pre-prepared CAB file,
open the file in a Zip utility (such as WinZip) and view the contained INF file. That file will
contain the full version of the contained ActiveX component
Don’t uncompress or modify the CAB file’s supplied by Iocomp Software.
Simply copy the CAB file to your server, and reference it in the codebase
parameter of the object tag. If you need to place our ActiveX in your own
self-created CAB file, then you will need to obtain a digital certificate from a
Cert provider such as Versign or Thawte. By using our digitally signed CAB
files or using your own digitally signed CAB file, your clients can leave their
Internet Security Settings set on High.
176
Licensing the Plot Pack ActiveX Control
All ActiveX controls that require licensing must have an LPK file specified in each web page that
uses that control. Since only one LPK file can be specified in any one web page, it is recommended
that you generate an LPK file for all ActiveX controls (no matter which vendor) that you may be
using in your web pages.
To integrate the LPK file into your web page, you will need to associate the LPK file with the
Microsoft License Manager control that is built into the Internet Explorer browser as follows…
<object CLASSID="clsid:5220cb21-c88d-11cf-b347-00aa00a28331" VIEWASTEXT>
<param name="LPKPath" value="pathname/LPKFile.lpk">
</object>
!
The CLASSID used is for the Microsoft License Manager control and not
the other ActiveX controls used in your web page!
To generate an LPK file, you will need to obtain the LPK Tool program from Microsoft. You can
download this tool from Microsoft’s Website and from their Internet Explorer Toolkit.
Accessing the Plot Pack ActiveX Control from VBScript
If you are familiar with Microsoft Visual Basic or VBA from Microsoft Office products, you should
find the VBScript language to be almost identical. Accessing the chart from your VBScript code
follows the same rules as Visual Basic. Consult documentation or books on how to use VBScript, or
consult our example below and in the Examples Section of our Support Website.
AddXY Example
Dim x
Dim XData
Dim YData
For x = 1 To 100
XData = XData + 1
'Plot XY Data Pair
Next
end sub
--></script>
VBScript does not support variable types. When you dimension your variables, do
not give a type. All variable types in VBScript are Variants.
177
Full Source Example
<html><head>
<title>Internet Explorer Plot Pack Example</title></head><body bgcolor="#FFFFFF">
Dim x
Dim XData
Dim YData
For x = 1 To 100
XData = XData + 1
'Plot XY Data Pair
Next
end sub
--></script></body></html>
178
Appendix A - Plot Pack Property Editors
Control General
•
User Can Edit Objects: Use to specify whether your application user can open the
runtime property editor by right-clicking on a plot object and select a popup “Edit” menu
item. Only the “Edit” popup items are disabled when this option is unchecked.
•
Auto Frame Rate: Use AutoFrameRate to specify whether the control automatically
activates the repaint frame rate control. When the AutoFrameRate is set to true, the
control automatically calls BeginUpdate when the control is performing its next repaint.
From then on, the control repaint frame rate is equal to the UpdateFrameRate no matter
how many changes are maid to the control every second.
•
Update Frame Rate: Use UpdateFrameRate to get or set the frame rate at which the
control repaints.
The frame rate is used to improve performance by controlling the number of times the
control repaints itself per second. To activate automatic frame rate control, the
UpdateFrameRate property must be non zero and the BeginUpdate method must be
called. To deactivate automatic frame rate control, call the EndUpdate method.
Each time a change occurs to the control that requires a repaint, the control will
179
determine if a new frame needs to be displayed. The FrameTime is one second divided by
the UpdateFrameRate. If a change occurs to the control before the FrameTime has
elapsed, the control is not repainted. If a change occurs to the control after the
FrameTime has elapsed, the control is repainted and the next frame is started.
There must be a steady stream of changes to the control that require repainting for the
automatic frame rate control to function correctly. The rate of change per second must be
greater than the UpdateFrameRate for the desired frame rate to be achieved. Once
changes to the control that require repainting have been stopped, call the EndUpdate
method to force the control to repaint the last changes that may be cached.
When the frame rate control is inactive, the control will attempt to repaint when a change
is made to the control that requires a repaint. The actual number of repaints per second is
dependent of the system hardware, system activity, and the number of request being
made to repaint the control.
The frame rate can be manually controlled by using the BeginUpdate and EndUpdate
methods. Make sure that the UpdateFrameRate property is set to 0 to disable automatic
frame rate control. Your code will need to keep track of the last update before beginning
a new frame. To begin a new frame, call the EndUpdate method and then the
BeginUpdate method to start the next frame.
•
Background Color: Use BackgroundColor to read or change the background color of the
control.
•
Border Style:Use BorderStyle to provide the control with a three-dimensional beveled
look.
Value
ibsNone
ibsRaised
ibsLowered
•
180
Meaning
No border.
The outer border is raised.
The outer border is lowered.
Outer Margin: Use OuterMarginLeft, OuterMarginRight, OuterMarginTop, or
OuterMarginBottom to set the margin between the left, right, top, or bottom side edge of
the control and the internal drawn elements. The values are specified in pixels.
Control Title
•
Title Visible: Use to show or hide the main chart title displayed above the DataView
area.
•
Title Text: Use to set the Title Text of the main chart title.
•
Title Margin: Use to set the margin between the bottom of the title and the DataView
area.
•
Title Font: Use to se the font of the title.
!
These properties have been depreciated in favor of our multiple label
support. Please use the Labels tab to set properties for the Title Label and
other labels in the Plot Component.
181
Control Print
•
Show Dialog: Use PrinterShowDialog to specify whether the printer setup dialog is
shown to the user when the PrintChart method is called. If Enabled, the user can select a
local or network printer, specify the orientation, number of copies, and etc before actually
printing the chart.
•
Orientation: Use PrinterOrientation to set the orientation of the chart on the printed
page.
Value
poPortrait
poLandscape
•
182
Meaning
Portrait
Landscape
Margin: The left, right, top, and bottom margins on the printed page.
Control Hints
•
Hints Show: Use HintsShow to specify whether Help Hints are shown for the entire
control.
•
Hints Pause: Use HintsPause to get or set the time interval that passes before the
control's Help Hint appears when the user places the mouse pointer on a object. The
HintsPause value is in milliseconds.
•
Hints Hide Pause: Use HintsHidePause to get or set the time interval to wait before
hiding the Help Hint if the mouse has not moved from the object. The HintsHidePause
value is in milliseconds.
183
Control File I/O
•
Log File Name: Use LogFileName to get or set the filename (including path) for the log
file. This is the log file for all axes.
Warning! All channels must be synchronized. You must use the AddDataArray method
when adding data to the plot component when using the main plot interface’s logging
feature. If you wish to use asynchronous channels, then you must use the LogFileName
logging feature off of each channel.
•
Log Buffer Size: Use LogBufferSize to get or set the size of the log buffer. When
logging is active, data will flow into the log buffer if the LogBufferSize is greater than 0.
When the buffer is filled, then data will be written to the log file and the buffer cleared.
This is useful if you want to regulate how often data is written to the log file. If this
value is 0, then data is written to the log file after every new data point is added to the
chart.
The value is in number of data points per channel. If you have 5 channels and set this
value to 10, then the log will be written to and the buffer cleared after 50 data points have
been accumulated.
Warning! All channels must be synchronous. You must use the AddDataArray method
when adding data to the plot component when using the main plot interface’s logging
feature. If you wish to use asynchronous channels, then you must use the LogBufferSize
logging feature off of each individual channel.
184
Note: if the log is deactivated, the buffer will automatically be flushed to the log file and
cleared.
•
Properties Save: Call SavePropertiesToFile to stream out all of the properties of the plot
component to a file.
•
Properties Load: Call LoadPropertiesFromFile to stream in all of the properties of the
plot component from a file.
Translation
•
Add: Adds a translation string pair to the list of translations.
•
Remove: Removes the selected translation from the list of translations.
•
ClearAll: Removes all translations from the list of translations.
•
Save: Exports a tab delimited text file of translation string pairs.
•
Load: Loads a tab delimited text file of translation string pairs.
•
Original String: The English string in the original component to be translated. Casesensitive. Leading and trailing spaces are NOT ignored.
•
Replacement String: The translated string, which replaces the Original String.
185
Annotation Defaults
•
Font: Specifies the default font attributes used when creating annotation objects.
•
Pen Color: Specifies the pen color used when drawing the annotation object.
•
Pen Style: . Use MarkersPenStyle to get or set the pen style used when drawing data
markers.
Value
psSolid
psDash
psDot
psDashDot
psDashDotDot
psClear
psInsideFrame
186
Meaning
A solid line
A line made up of a series of dashes
A line made up of a series of dots
A line made up of alternating dashes and dots
A line made up of a serious of dash-dot-dot combinations
No line is drawn (used to omit the line around shapes that
draw an outline using the current pen)
A solid line, but one that may use a dithered color if
Width is greater than 1
•
Pen Width: . Use MarkersPenWidth to get or set the pen width used when drawing data
markers.
•
Brush Color: Use MarkersBrushColor to get or set the brush color used to draw data
markers.
•
Brush Style: Use MarkersBrushStyle to get or set the brush style used when drawing
data markers.
Value
bsSolid
bsClear
bsHorizontal
bsVertical
bsFDiagonal
bsBDiagonal
bsCross
bsDiagCross
Meaning
Solid
Clear
Horizontal Lines
Vertical Lines
Diagonal Bottom-Left
to Top-Right
Diagonal Top-Left to
Bottom-Right
Combination of
bsHorizontal and
bsVertical
Combination of
bsFDiagonal and
bsBDiagonal
Visual Layout Manager
187
188
•
How To Use: The Layout Manager is a visual, graphical representation of the individual
plot component objects as they are drawn on the component. You can drag-and-drop
individual items to reposition them within the control. You can also change the width and
height of objects by placing your mouse cursor over one of the ends of the objects (look
for the cursor to change to a double arrow) and dragging them to the desired size. If you
drop one axes object on another, and they do not overlap, then the axes will stack on top
of one another. To flip the X and Y-Axes, right click anywhere in the Layout Manager
for a menu item to rotate the X and Y-Axes.
•
Toolbar: The Toolbar object. This item cannot be moved at this time. A feature to
reposition this item will be added in future versions.
•
Label: The Label Object. In this example, the only label in the component is named
“Title”. There must always be at least one label in the component for backward
compatibility with older versions, though it can be hidden.
•
Data View: The object which contains the plotted data. All objects move in relation to
this object, so it is fixed.
•
X-Axis: An individual X-Axis. If you have added multiple X-Axes, there would be
multiple X-Axis objects which you could reorder or stack.
•
Y-Axis: An individual Y-Axis. If you have added multiple Y-Axes, there would be
multiple Y-Axis objects which you could reorder or stack.
•
Legend: The Legend Object. This object cannot be flipped at this time, only moved.
Only one Legend object is supported at this time.
Channels General
•
Channel List: A listing of the channels that have been added to the Chart.
•
Add Button: Adds a channel to the list
•
Remove Button: Removes the selected channel from the list
•
Name: Use Name to set the Plot Object’s name. This name can then be used to reference
the object. There is no restrictions on the length of the name or the characters used.
•
Title: Use TitleText to get or set the title text for the channel. This is the title that is
displayed in the legend for this channel.
•
Ring Buffer Size: Use RingBufferSize to get or set the size of the data buffer used for
storing channel data. By setting this property to a non-zero value, the ring buffer feature
is enable. To disable the ring buffer feature, set this property to 0. The ring buffer will
remain a constant size no matter how many data points are added to the channel and will
act like a FIFO (First In First Out).
•
Visible: Use the Visible property to show or hide a specific Plot Object.
•
Visible In Legend: Use VisibleInLegend to specify whether the channel is shown in the
legend.
189
•
Popup Enabled: Use the PopupEnabled property to enable or disable the Popup Menu of
a Plot Object. The Popup Menu is shown when a user right-clicks on this Plot Object.
Setting this property to FALSE is useful if you don’t want the Popup Menu functionality
of this Plot Object in your particular application.
Note: when the Enabled property is set to FALSE, then this property will have no effect
and the Popup will be disabled.
190
•
Fast Draw: Enables or disables the Fast Draw feature. This feature dramatically speeds
up redraws to the screen if you are displaying large data sets (>100000 data points).
•
Color: Use Color to get or set the color of the channel. The Color property is used by the
Trace drawing routine and is used by default for the Markers and Fill drawing routines.
•
X-Axis Name: Use XAxisName to get or set the name of the x-axis used for plotting the
channel x data against. If the XAxisName is not a valid x-axis name, the channel data
will not be drawn.
•
Y-Axis Name: Use YAxisName to get or set the name of the Y-Axis used for plotting the
channel y data against. If the YAxisName is not a valid Y-Axis name, the channel data
will not be drawn.
•
X-Axis Tracking Enabled: Use XAxisTrackingEnabled to specify whether the channel
sends tracking data to its assigned x-axis.
•
Y-Axis Tracking Enabled: Use YAxisTrackingEnabled to specify whether the channel
sends tracking data to its assigned Y-Axis.
Channel Trace
•
Visible: Use TraceVisible to specify whether the channel trace line is visible. Typically
the trace line is hidden for a scatter type plot.
•
Line Style: Use TraceLineStyle to get or set the line style of the channel trace line.
Value
iplsSolid
iplsDash
iplsDot
iplsDashDot
iplsDashDotDot
•
Meaning
A solid line
Line Width: Use TraceLineWidth to get or set the pen width used when drawing the
channel trace line.
191
Interpolation
•
192
Style: .
Channels Markers
•
Show: Use MarkersVisible to specify whether the data markers are visible.
•
Allow Individual: Use MarkersAllowIndividual to specify whether the DataMarkerShow
and DataMarkerStyle properties are used to draw individual data point data markers.
When this property is set to True, then the data markers are initially drawn using the
MarkersStyle property but can be modified individually with the DataMarkerShow and
DataMarkerStyle properties. When this property is set to False, then all of the data
markers are drawn using the MarkersStyle property of the channel.
•
Style: Use MarkersStyle to get or set the style of the data markers.
Value
ipmsCircle
ipmsSquare
ipmsDiamond
ipmsCross
ipmsPlus
ipmsTriangleUp
ipmsTriangleDown
ipmsTriangleLeft
ipmsTriangleRight
Meaning
Circle
Square
Diamond
Cross
Plus
Triangle Pointing Up
Triangle Pointing Down
Triangle Pointing Left
Triangle Pointing Right
193
•
Size: Use MarkersSize to get or set the size of data markers. The MarkersSize value is in
pixels.
•
Pen Use Channel Color: Use MarkersPenUseChannelColor to specify whether markers
use the channel color for the pen color. When MarkersPenUseChannelColor is set to
True, the pen uses the color of the Color property. When MarkersPenUseChannelColor is
set to False, the pen uses the color of the MarkersPenColor property.
•
Pen Style: Use MarkersPenStyle to get or set the pen style used when drawing data
markers.
Value
psSolid
psDash
psDot
psDashDot
psDashDotDot
psClear
psInsideFrame
194
Meaning
A solid line
No line is drawn (used to omit the line around shapes that
draw an outline using the current pen)
Width is greater than 1
•
Pen Color: Use MarkersPenColor to get or set the pen color used to draw data markers.
•
Pen Width: Use MarkersPenWidth to get or set the pen width used when drawing data
markers.
•
Brush Use Channel Color: Use MarkersBrushUseChannelColor to specify whether
markers use the channel color for the brush color. When MarkersBrushUseChannelColor
is set to True, the brush uses the color of the Color property. When
MarkersBrushUseChannelColor is set to False, the brush uses the color of the
MarkersBrushColor property.
•
Brush Style: Use MarkersBrushStyle to get or set the brush style used when drawing
data markers.
Value
bsSolid
bsClear
bsHorizontal
bsVertical
bsFDiagonal
bsBDiagonal
bsCross
bsDiagCross
•
Meaning
Solid
Clear
Horizontal Lines
Vertical Lines
Diagonal Bottom-Left
to Top-Right
Diagonal Top-Left to
Bottom-Right
Combination of
bsHorizontal and
bsVertical
Combination of
bsFDiagonal and
bsBDiagonal
Brush Color: Use MarkersBrushColor to get or set the brush color used to draw data
markers.
Channels Fill
195
•
Enabled: Use FillEnabled to specify whether a fill is drawn underneath the channel data.
•
Use Channel Color: Use FillUseChannelColor to specify whether the fill uses the
channel color when drawing the fill underneath the channel data. When
FillUseChannelColor is set to True, the fill color used is the Color property value. When
FillUseChannelColor is set to False, the fill color used is the FillColor property value.
•
Reference: Use FillReference to get or set the reference line that the fill is drawn to on
the Y-Axis.
•
Color: FillColor to get or set the brush color used to paint the fill under the data.
•
Style: Use FillStyle to get or set the brush style used when drawing the fill underneath the
channel data.
Value
bsSolid
bsClear
bsHorizontal
bsVertical
bsFDiagonal
bsBDiagonal
bsCross
bsDiagCross
196
Meaning
Solid
Clear
Horizontal Lines
Vertical Lines
Diagonal Bottom-Left to Top-Right
Diagonal Top-Left to Bottom-Right
Combination of bsHorizontal and bsVertical
Combination of bsFDiagonal and bsBDiagonal
Channels Digital
•
Enabled: Use DigitalEnabled to specify whether the data in the channel is interpreted as
digital or analog data.. If DigitalEnabled is TRUE, then values of 0 and 1 are plotted
against DigitalReferenceLow and DigitalReferenceHigh respectively.
Y coordinate values that are equal to 0 (i.e. Value = 0) are plotted on the scale at the Y
coordinate specified by DigitalReference Low.
X coordinates that are not equal to 0 (i.e. 0 < Value > 0) are plotted on the scale at the Y
coordinate specified by DigitalReference High.
•
Reference High: Use DigitalReferenceHigh to get or set the Y coordinate for digital high
values or Logic = TRUE used for plotting data points while in Digital Mode when the
value is not equal to 0 (i.e. 0 < Value > 0).
•
Reference Low: Use DigitalReferenceLow to get or set the Y coordinate for digital low
values or Logic = FALSE used in Digital Mode while in Digital Mode when the value is
equal to 0 (i.e. Value = 0).
197
•
Reference Style: Use DigitalReferenceStyle to get or set the formatting style of a digital
channel.
Value
ipdrScale
ipdrPercent
Meaning
DigitalReferenceLow and DigitalReferenceHigh
properties are interpreted as actual values on the
associated Y-Axis Scale
DigitalReferenceLow and DigitalReferenceHigh
properties are interpreted as a percentage of the distance
from the bottom of the DataView (0%) and the top of the
DataView (100%) [Note: Acceptable values are between
0 and 100]
Channel File I/O
•
Log File Name: Use LogFileName to get or set the filename (including path) for the log
file. This is the log file only for the associated channel.
Note: Channels may be synchronous or asynchronous. If you are only using synchronous
data, you can use the LogFileName logging feature off of the main component interface
to save all channel data to a single log file.
198
•
Buffer Size: Use LogBufferSize to get or set the size of the log buffer. When logging is
active, data will flow into the log buffer if the LogBufferSize is greater than 0. When the
buffer is filled, then data will be written to the log file and the buffer cleared. This is
useful if you want to regulate how often data is written to the log file. If this value is 0,
then data is written to the log file after every new data point is added to the chart.
Note: Channels may be synchronous or asynchronous. If you are only using synchronous
data, you can use the LogBufferSize logging feature off of the main component interface
to save all channel data to a single log file.
Note: if the log is deactivated, the buffer will automatically be flushed to the log file and
cleared.
•
Properties Save: Call SavePropertiesToFile to stream out all of the properties of the
associated channel to a file.
•
Properties Load: Call LoadPropertiesFromFile to stream in all of the properties of the
associated channel from a file.
Cursors General
•
Cursor Name: Use Name to set the Plot Object’s name. This name can then be used to
reference the object. There is no restrictions on the length of the name or the characters
used.
199
•
Cursor Style: Use Style to get or set the style of the data cursor object. The style
determines the type and behavior of the cursor.
Note: data points are interpolated when used with the iPlot component.
These are the possible values:
Value
ipcsValueXY
ipcsValueX
ipcsValueY
ipcsDeltaX
ipcsDeltaY
ipcsInverseDeltaX
Meaning
Displays Data Point’s ValueX and ValueY with a
single pointer line for the iPlot component and a
cross-hair (two pointer lines) for the iXYPlot
component.
Displays Data Point’s ValueX with a single pointer
line
Displays Data Point’s ValueY with a single pointer
line
Displays Data Points’ X Span between to pointer
lines.
Use ValueX to retrieve the X Span.
Displays Data Points’ Y Span between to pointer
lines.
Use ValueY to retrieve the Y Span.
Displays Frequency between two pointer lines.
Uses scale values and CursorScaler property of
the associated channel’s X-Axis. Use ValueX to
retrieve the calculated value.
•
Cursor Channel Name: Use ChannelName to get or set the name of the channel used for
referencing. This property associates a particular channel’s data with the cursor. Data
from the channel is then used by the cursor to display individual data points, ranges, and
other cursor calculated values.
•
Pointer 1 Position: Use Pointer1Position to get or set the position of the first cursor
pointer. The units of the Pointer1Position are in reference to the DataView area in
percent. Therefore the only valid values are between 0 and 100.
If the data cursor is horizontal, the position is in reference to the Y-Axis side of the
DataView area with 0 being the bottom of the DataView and 100 being the top of the
data view.
If the data cursor is vertical, the position is in reference to the X-Axis side of the
DataView area with 0 being the left side of the DataView and 100 being the right side of
the data view.
200
For data cursors of style ValueXY (iPlot Component Only), ValueX, and ValueY, this
property sets the position of the single cursor line used with these data cursor styles.
•
Pointer 2 Position: Use Pointer2Position to get or set the position of the second cursor
pointer. The units of the Pointer2Position are in reference to the DataView area in
percent. Therefore the only valid values are between 0 and 100.
For data cursors of style ValueXY (iPlot Component Only), ValueX, and ValueY, this
property is ignored since they don’t have a second cursor line..
•
Pointer Color: Use Color to get or set the color of the data cursor line or lines. This
property is overridden if the UseChannelColor property is set to True.
•
Use Channel Color: Use UseChannelColor to specify whether the data cursor line use
the channel color for the line color. When UseChannelColor is set to True, the data cursor
line is drawn using the associated Channel’s Color property. When UseChannelColor is
set to False, the data cursor line is drawn using the Data Cursor’s Color property.
•
Cursor Font: Use Font to change the font attributes of the data cursor hint.
•
201
Cursors Hint
•
Show: Use HintShow to specify whether the hint is shown next to the data cursor in the
DataView area. You will generally want to leave this value set to TRUE so that the X
and/or Y values of the cursor are displayed next to the cursor.
When this property is set to false, you will need to use the OnCursorChange event to be
notified when the cursor moves so that you can externally display or react to the X and Y
values of the cursor..
•
Hide On Release: Use HintHideOnRelease to specify whether the hint is automatically
hidden when the user releases the mouse button. The hint will be shown when the user
selects, clicks down, and while moving the cursor in the DataView area. If this property
is set to True, then the hint will immediately be hidden when the mouse is released.
•
Position: Use HintPosition to get or set the position of a hint object next to a data cursor.
The value is specified in percent of the horizontal or vertical range of the DataView Area.
If HintPosition = 25 and the cursor is horizontal, then the left-side of the hint will be 25%
of the distance from the left side of the DataView area.. If HintPosition = 60 and the
cursor is vertical, then the top side of the hint will be 60% of the distance from the top
side of the DataView area.
202
•
Orientation Side: Use HintOrientationSide to get or set the orientation of the hint
displayed next to the cursor.
Note: the orientation will automatically be flipped if a cursor is moved in such a way as
to move the hint window outside of the DataView area (i.e. there is no room between the
cursor and the edge of the DataView boundaries).
Value
iosBottomRight
iosTopLeft
Meaning
Displays the hint to the right of a vertical cursor and
below a horizontal cursor.
Displays the hint to the left of a vertical cursor and
above a horizontal cursor.
Cursors Menu Items
•
Value XY Visible: Use MenuItemVisibleValueXY to specify whether right-click,
context-sensitive menu for the data cursor object displays the “ValueXY” entry. This
menu item allows the user to change the cursor to display both X and Y values.
•
Value X Visible: Use MenuItemVisibleValueX to specify whether right-click, contextsensitive menu for the data cursor object displays the “ValueX” entry. This menu item
allows the user to change the cursor to display only X values.
203
204
•
Value Y Visible: Use MenuItemVisibleValueY to specify whether right-click, contextsensitive menu for the data cursor object displays the “ValueY” entry. This menu item
allows the user to change the cursor to display only Y values.
•
Delta X Visible: Use MenuItemVisibleInverseDeltaX to specify whether right-click,
context-sensitive menu for the data cursor object displays the “
•
InverseDeltaX” entry. This menu item allows the user to change the cursor to display the
inverse of the range of X values between two cursor lines (value = 1/range). This is
typically used in conjunction with the Axis CursorScaler property to display calculated
frequency values.
•
Delta Y Visible: Use MenuItemVisibleDeltaY to specify whether right-click, contextsensitive menu for the data cursor object displays the “DeltaY” entry. This menu item
allows the user to change the cursor to display the range of Y values between two cursor
lines.
•
Inverse Delta X Visible: Use MenuItemVisibleInverseDeltaX to specify whether rightclick, context-sensitive menu for the data cursor object displays the “InverseDeltaX”
entry. This menu item allows the user to change the cursor to display the inverse of the
range of X values between two cursor lines (value = 1/range). This is typically used in
conjunction with the Axis CursorScaler property to display calculated frequency values..
•
Value XY Caption: Use MenuItemCaptionValueXY to specify the caption of the
“ValueXY” right-click, run-time popup menu for the data cursor object. This is useful for
customizing the menu for application specific descriptions. The menu item allows the
user to change the cursor to display both X and Y values.
•
Value X Caption: Use CaptionValueX to specify the caption of the “ValueX” rightclick, run-time popup menu for the data cursor object. This is useful for customizing the
menu for application specific descriptions. The menu item allows the user to change the
cursor to display only X values.
•
Value Y Caption: Use MenuItemCaptionValueY to specify the caption of the “ValueY”
right-click, run-time popup menu for the data cursor object. This is useful for
user to change the cursor to display only Y values.
•
Delta X Caption: Use MenuItemCaptionDeltaX to specify the caption of the “DeltaX”
user to change the cursor to display the range of X values between two cursor lines.
•
Delta Y Caption: Use MenuItemCaptionDeltaY to specify the caption of the “DeltaY”
user to change the cursor to display the range of Y values between two cursor lines.
•
Inverse Delta X Caption: Use MenuItemCaptionDeltaX to specify the caption of the
“InverseDeltaX” right-click, run-time popup menu for the data cursor object. This is
useful for customizing the menu for application specific descriptions. The menu item
allows the user to change the cursor to display the inverse of the range of X values
between two cursor lines (value = 1/range). This is typically used in conjunction with
the Axis CursorScaler property to display calculated frequency values..
Limits General
•
205
•
Style: Use Style to get or set the style of the limit object. The style determines the type
of the limit and how it is drawn on the screen and manipulated.
Value
iplsLineX
iplsLineY
iplsBandX
iplsBandY
iplsPolyBandX
iplsPolyBandY
•
Meaning
Displays a single line perpendicular to the X-Axis at
a position specified by Line1Position.
Displays a single line perpendicular to the Y-Axis at
Displays a filled or two line band perpendicular to the
X-Axis specified by the Line1Position and .
Y-Axis specified by the Line1Position and
Line2Position properties.
Displays a filled or two line band using elements
(upper and lower limit values specified for a
particular Y-Axis positions) added by the
AddBandElement method.
Displays a filled or two line band using band
elements (upper and lower limit values specified for a
Line 1 Position: Use Line1Position to get or set the position of the first limit line. The
units of the Line1Position are in reference to the values on the referenced axis of interest.
This property is used for all limit line styles.
For limit lines of style LineX and LineY, this property sets the position of the single limit
line used with these limit styles.
CursorStyle
iplsLineX
iplsLineY
Position Value Meaning
References the X-Axis scale referenced in the
XAxisName property.
References the Y-Axis scale referenced in the
YAxisName property.
For limit lines of style BandX and BandY, this property sets the position of the first
cursor line with these fill-region or dual-line data limit line styles. For limit lines of style
PolyBandX or PloyBandY, this property is ingored.
206
CursorStyle
iplsBandX
iplsBandY
iplsPolyBandX
iplsPolyBandY
•
XAxisName property.
YAxisName property.
Property Ignored. Use AddBandElement.
Line 2 Position: Use Line2Position to get or set the position of the second limit line. The
units of the Line2Position are in reference to the values on the referenced axis of interest.
For limit lines of style LineX and LineY, this property is ignored.
CursorStyle
iplsLineX
iplsLineY
Property Ignored. Use Line1Position instead.
Property Ignored. Use Line1Position instead.
For limit lines of style BandX and BandY, this property sets the position of the second
cursor line with these fill-region or dual-line data limit line styles. For limit lines of style
PolyBandX or PloyBandY, this property is ingored.
CursorStyle
iplsBandX
iplsBandY
iplsPolyBandX
iplsPolyBandY
XAxisName property.
YAxisName property.
207
•
Fill Style: Use FillStyle to get or set the fill style used when drawing the fill between
limit lines. This property has no effect if the Limit Style property is set to iplsLineX or
iplsLineY.
Value
bsSolid
bsClear
bsHorizontal
bsVertical
bsFDiagonal
bsBDiagonal
bsCross
bsDiagCross
•
Meaning
Solid.
Clear. No fill will be created, but two solid lines of
line width 1 using the Limit’s Color property will be
drawn at the Line1Position and Line2Position
positions.
Horizontal Lines.
Vertical Lines.
Diagonal Bottom-Left to Top-Right.
Diagonal Top-Left to Bottom-Right.
Combination of bsHorizontal and bsVertical.
Combination of bsFDiagonal and bsBDiagonal.
Line Style: Use LineStyle to get or set the line style of the limit line or lines. This
property is ignored if the Limit’s Style property is set to iplsBandX, iplsBandY,
iplsPolyBandX, or iplsPolyBandY.
Value
psSolid
psDash
psDot
psDashDot
psDashDotDot
psClear
psInsideFrame
Meaning
A solid line.
A line made up of a series of dashes.
A line made up of a series of dots.
A line made up of alternating dashes and dots.
A line made up of a series of dash-dot-dot
combinations.
No line is drawn.
Width is greater than 1.
Note: Only the psInsideFrame style will produce a dithered color to match a Color
property that is not in the color table. All others choose the closest color from the
Windows color table.
Note: Dotted or dashed pen styles are not available when the Width property is not 1
or 0.
208
•
Line Width: Use LineWidth to get or set the pen width used when drawing the limit line
or lines. This property is ignored if the Limit’s Style property is set to iplsBandX,
iplsBandY, iplsPolyBandX, or iplsPolyBandY.
•
Color: Use Color to get or set the color of the limit line or lines…
Value
iplsLineX
iplsLineY
iplsBandX
iplsBandY
iplsPolyBandX
iplsPolyBandY
Meaning
Displays a single line perpendicular to the X-Axis at
Displays a single line perpendicular to the Y-Axis at
Displays a filled or two line perpendicular to the XAxis specified by the Line1Position and
Y-Axis specified by the Line1Position and
Displays a filled or two line band using elements
(upper and lower limit values specified for a
Displays a filled or two line band using band
elements (upper and lower limit values specified for a
•
X-Axis Name: Use XAxisName to get or set the name of the X-Axis used for
referencing. This property is used by the Line1Position, Line2Position, and
AddBandElement properties and methods for positioning the limit line or lines against
the specified X-Axis.
•
Y-Axis Name: Use YAxisName to get or set the name of the Y-Axis used for
referencing. This property is used by the Line1Position, Line2Position, and
AddBandElement properties and methods for positioning the limit line or lines against
the specified Y-Axis.
209
Axes General
•
•
Min: Use Min to get or set the minimum value that will be display on the axis.
•
Span: Use Span to get or set the range displayed on the axis.
•
Desired Start: Use DesiredStart to get or set the desired start for the axis scale. This
property will affect what value will be on the first major tick of the axis.
Let’s say the Axis starts at 0, but you want it to start at 9. Setting this value to 9 will
instruct the Axis to start the first major tick on 9 and then follow the DesiredIncrement
property for all further major ticks.
Note: due to performance issues, this property only has effect if the value exists in the
visible axis (i.e. the value must be equal to or between the axis’ min and max values).
This feature is only intended to be used with static scales (scales that do not scroll).
Set this property to 0 to disable this feature and use the default 1-2-5 rules.
210
•
Desired Increment: Use DesiredIncrement to get or set the desired increment for the
axis scale.
If this property is set to 0, then the AutoScale feature of the axis scale will automatically
adjust the scale to follow a 1-2-5 rule, which ensures that the scale major ticks and labels
fall along “human-readable” whole numbers such as “0,25,50,75,100”,
“0,10,20,30,40,50,60,70,80,90,100”, etc. depending on your min and span property
settings.
If this property is greater than zero, the AutoScale feature will attempt to create a scale
using your increment values depending on your min and span property settings, adding
major ticks and labels that will fit in the area used by the scale. If the AutoScale finds
that not all of the labels will fit in the scale area (depends on your font properties), then it
will attempt to fit as many labels as possible using this setting.
For example, if you want the scale to increment by values of “2.5”, and your min and
span properties are 0 and 50, then the AutoScale code will attempt to create a scale with
“0, 2.5, 5.0, 7.5, 10, 12.5, …, 40, 42.5, 45, 47.5, 50”. If not all of the labels can fit in the
space allocated to the scale, it will attempt to fit as many labels as possible using the 1-25 rule..
•
Scale Type: Use ScaleType to get or set the type of scale. When the scale type is set to
ipstLog10, the Min and Span properties are restricted to being greater than 0.
Value
ipstLinear
ipstLog10
Meaning
Linear
Logarithmic Base 10
•
•
Enabled: Use the Enabled property to enable or disable the UI (User Interface) of a Plot
Object.
When this property is set to TRUE, then the UI functionality (ability to move a scale,
scroll a list, click on buttons, etc) of the Plot Object is enabled. Note that setting this
property to TRUE will not override other properties that affect the UI of this Plot Object.
When this property is set to FALSE, then the UI functionality of the Plot Object is
disabled. Note that this will override all other properties that affect the UI of this Plot
Object.
Note: when a Plot Object is disabled, the Plot Object will not “look disabled” like
standard textboxes or labels. Only the UI will be disabled.
•
211
•
Reverse Scale: Use ReverseScale to specify whether the scale is reversed. If
ReverseScale is False, the axis goes from left to right for horizontal orientation or bottom
to top for vertical orientation. If ReverseScale is True, the axis goes from right to left for
horizontal orientation, or top to bottom for vertical orientation.
•
Restore Values On Resume: Use RestoreValuesOnResume to set whether or not the
axis restores the original axis parameters and values that were in effect when the Pause
All Tracking Button is clicked. All parameters (such as axis min and span) are restored
when the Resume All Tracking Button is clicked and this property is set to TRUE.
•
Master UI Input: Use MasterUIInput to set this axis to be the Master User Interface for
all axes of this type.
For example, let’s say you have three (3) YAxes. If you set this property to TRUE on
the first Y-Axis, then all UI (User Input, such as mouse or keyboard input) on that axis
will be applied to all other Y-Axes. The X-Axes will not be affected as they are not YAxes (i.e. they are not the same type).
This is useful if you want the scrolling action of one axis to be synchronized with all
other axes of the same type. If you want all Axes of the same type to be synchronized,
set this property to TRUE on all of them. If you want all Axes to be independent, set this
property to FALSE on all of them.
212
Axes Title
•
Axes Title Show: Use TitleShow to specify whether the axis title is shown.
•
Axes Title Text: Use Title to get or set the title text for the axis. To hide the title, use the
TitleShow property.
•
Axes Title Margin: Use TitleMargin to get or set margin between the axis title and axis
scale labels. TitleMargin represents the percentage of a character size and is based on the
TitleFont used for the axis. A value of 0.5 is equal to half the size of a character.
•
Axes Title Font: The Font for the Title.
213
Axes Labels
•
Min Length: Use LabelsMinLength to get or set the minimum label length used in
calculating the number of scale labels (Major Ticks) during AutoScale. This property has
no effect if the axis is not horizontal.
AutoScale automatically calculates the number of scale labels based on the LabelsFont,
LabelSeparation, and LabelsMinLength to ensure labels that are in a human readable
format (1-2-5 Rule).
•
Precision: Use LabelsPrecision to get or set the precision of the axis labels. The actual
number of digits shown to the right of the decimal place depends on the setting of the
LabelsPrecisionStyle property.
For example, if LabelsPrecision is 1, LabelsPrecisionStyle is set to
ipsFixedDecimalPoints, and the value is 40.56 then the label text will be formatted to
display “40.6”. To show integers only, set LabelsPrecision to 0.
214
•
Margin: Use LabelsMargin to get or set the spacing between the major tick and major
tick labels. LabelsMargin represents the percentage of a character size and is based on the
LabelsFont used for the axis. A value of 0.5 is equal to half the size of a character.
•
Label Separation: Use LabelSeparation to get or set the minimum separation between
scale labels. LabelSeparation represents the percentage of a character size and is based on
the LabelsFont used for the axis. A value of 0.5 is equal to half the size of a character.
The actual separation maybe greater due to the AutoScale reducing the number of major
ticks to keep the scale labels in a human readable format (1-2-5 Rule).
•
Min Length Auto Adjust: Use LabelsMinLengthAutoAdjust to specify whether the
LabelsMinLength property is automatically adjusted as the minimum required label
length increases.
While plotting, or user scrolling/zooming, the actual minimum label length may become
greater than the LabelsMinLength property value. This will result it the axis growing in
size to accommodate the wider label. If the plotting data or user changes the displayed
data causing the label width to vary, it may cause an annoying oscillation of the display
plot objects sizes. To prevent this oscillation, set this property to true.
The LabelsMinLength property is stored when the TrackingEnabled property is set to
False. The LabelsMinLength property will be restored to the previous value when
TrackingEnabled property is set back to True.
•
Precision Style: Use PrecisionStyle to specify how the LabelsPrecision property is
interpreted when formatting scale labels.
When PrecisionStyle is set to ipsSignificantDigits, the number of digits to the right of the
decimal point is automatically calculated to ensure that the span of the values will show
enough significant digits.
For Example :
LabelsPrecision = 3
LabelsPrecisionStyle = ipsSignificantDigits
Span = 50
Number of digits shown to the right of the decimal point = 1
Value
ipsSignificantDigits
ipsFixedDecimalPoi
nts
Meaning
Precision property specifies the number of
significant digits
Precision property specifies the number of digits to
the right of the decimal point
215
•
Format Style: Use LabelsFormatStyle to get or set the formatting style of scale labels.
Value
iptfValue
iptfExponent
iptfPrefix
iptfDateTime
iptfPrice32nds
•
Meaning
Simple Value (ex. 198678.567)
Exponential (ex. 2.35E+002)
Prefix (ex. 2.2K)
Date/Time (ex. 3 Jan 01 5:23:44)
ex. 100.231This format is used in the Bond and
Securities Market. Displayed where 23 is in 32nds and
1 is in 256ths. So in decimal the price above is: 100
+23/32 + 1/256. Pass the actual double value of
100.72265625 to display it as Price32nds format as
100.231.
Date Time Format: Use DateTimeFormat to get or set the Date/Time formatting string
for the labels. See FormatDateTime for specific values.
Axes Tracking
•
216
Enabled: Use TrackingEnabled to specify whether the axis will adjust itself to new
tracking data from the channels. Depending on the TrackingStyle, When the
TrackingEnabled property is set to True, the axis will scroll or compress based on the
new tracking data.
•
Style: Use TrackingStyle to specify how the axis adjusts itself in response to new
tracking data if off scale.
Value
iptsScaleMin
Max
iptsScaleMax
iptsScaleMin
iptsScrollSmo
oth
iptsScrollPage
•
Align First Style: Use TrackingAlignFirstStyle to specify how the axis aligns itself when
it receives it first piece of tracking data. If there is more than one channel sending
tracking data, only the data from the first channel is used to set the first alignment. To
force the axis to realign to the next piece of tracking data, call the ResetFirstAlign
method.
Value
ipafsMin
ipafsMax
ipafsAuto
ipafsNone
•
Meaning
Will adjust the Min or Span property to keep the new
tracking data in view
Will adjust the Max property if necessary to keep the
new tracking data in view
Will adjust the Min property if necessary to keep the
new tracking data in view
If the data is off axis, the scale will be adjusted to show
the data at the end of the scale
If the data is off axis, the scale will be adjusted to show
the data at the beginning of the scale
Meaning
Axis is adjusted to show first data point on the
beginning of the scale
Axis is adjusted to show first data point on the end of
the scale
Axis is unchanged if first data point is in view. If out of
view then the axis is adjusted to show first data point
on the beginning of the scale
Axis is not adjusted on the first data point
Scroll Compress Max: Use TrackingScrollCompressMax to get or set the maximum
span value when compressing the scale. When new tracking data is received and the
TrackingEnabled is set to True, the Span property will be increased (Compressed) to
include the tracking data if the current Span property is less than the
TrackingScrollCompressMax. To disable this feature, set TrackingScrollCompressMax to
0.
217
Axes Cursor
•
Cursor Precision: Use CursorPrecision to get or set the precision of the cursor ToolTips.
The actual number of digits shown to the right of the decimal place depends on the
setting of the LabelsPrecisionStyle property.
For example, if CursorPrecision is 1, LabelsPrecisionStyle is set to
ipsFixedDecimalPoints, and the value at the current cursor position is 40.56 then the
cursor ToolTip text will be formatted to display “40.6” (actual display of one data point,
two data points, or a calculated value depends on the cursor’s property settings). To show
integers only, set LabelsPrecision to 0.
Note: this is a property of the Axis and not of the cursor object since the scale will be
determining the precision of the data displayed in the cursor if the cursor is setup to use
this axis for obtaining scale data. To modify properties of the cursor object or to
associate a cursor with this axis object, refer to iPlotDataCursorX .
•
Cursor Scaler: Use CursorScaler to get or set the desired scalar for the cursor associated
with this axis scale.
CursorScaler is only used with cursors that have their Style property set to
InverseDeltaX, typically used for frequency calculations. The Scalar is a multiplier used
to convert this axis’ units to seconds format so that the cursor can property display the
frequency calculation.
218
For example, if the axis units are ms (milliseconds or 1/1,000th of a second), then you
would need to set the Scalar to 1,000 to convert from ms to seconds. If the units are µs
(microseconds or 1/1,000,000th of a second), then the Scalar should be set to 1,000,000
to convert from µs to seconds. If your units are already in seconds on this axis, then you
would set the Scalar to 1.
Axes Scroll
•
Min/Max Enabled: Use ScrollMinMaxEnabled to specify whether scrolling of the axis
is fixed to a range of values specified by ScrollMax and ScrollMin. If this property is set
to True, then the axis will stop scrolling when ScrollMax and/or ScrollMin are reached
on the scale.
•
Min: Use ScrollMin to set a fixed maximum limit on scrolling of the axis. If the user
attempts to scroll the axis past this point on the axis and ScrollMinMaxEnabled is set to
True, the axis will not scroll past the specified maximum point.
•
Max: Use ScrollMax to set a fixed maximum limit on scrolling of the axis. If the user
attempts to scroll the axis past this point on the axis and ScrollMinMaxEnabled is set to
True, the axis will not scroll past the specified maximum point.
219
Axes Scale
220
•
Major Length: Use MajorLength to get or set the axis major ticks length.
•
Minor Length: Use MinorLength to get or set the axis minor ticks length.
•
Minor Count: Use MinorCount to get or set the number of axis minor ticks shown.
MinorCount should be set to one less than the desires number of minor sections. For
example, if you want 5 minor sections, set MinorCount to 4.
•
Scale Lines Color: The color of the lines used to draw the scale.
•
Inner Margin: Use InnerMargin to get or set the margin between the axis line and the
side towards the data view. The InnerMargin value is in pixels.
•
Outer Margin: Use OuterMargin to get or set margin between the axis labels or the axis
title if shown and the side away form the data view. The OuterMargin value is in pixels.
•
Stacking Ends Margin: Use StackingEndsMargin to get or set the margin at the end of
the axis when stacked. StackingEndsMargin represents the percentage of a character size
and is based on the LabelFont used for the axis. A value of 0.5 is equal to half the size of
a character.
•
Start Percent: Use StartPercent to get or set the starting position within the plot layout
drawing area where the layout object is drawn.
The reference for 0% is the bottom or left of the data view and depends on the orientation
of the layout object. The reference for 100% is the top or right of the data view and
depends on the orientation of the layout object
Currently, only the axes support the StartPercent and StopPercent properties. The legend,
and toolbar ignore the StartPercent and StopPercent properties.
•
Stop Percent: Use StopPercent to get or set the stopping position within the plot layout
drawing area where the layout object is drawn.
The reference for 0% is the bottom or left of the data view and depends on the orientation
of the layout object. The reference for 100% is the top or right of the data view and
depends on the orientation of the layout object
Currently, only the axes support the StartPercent and StopPercent properties. The legend,
and toolbar ignore the StartPercent and StopPercent properties.
Legend
•
•
Object.
221
Object.
•
•
Column Spacing: Use ColumnSpacing to get or set the spacing between columns in the
legend. ColumnSpacing represents the percentage of a character size and is based on the
Font used in the Legend. A value of 0.5 is equal to half the width of a character.
•
Channel Name Max Width: Use ChannelNameMaxWidth to specify the maximum
channel name width allowed in the Legend before word wrapping occurs.
This property allows you to set a maximum width of the Channel Name column, allowing
those channel names that exceed this width to word-wrap to the next line..
222
•
Row Spacing: Use RowSpacing to get or set the spacing between rows in the legend.
RowSpacing represents the percentage of a character size and is based on the Font used
in the Legend. A value of 0.5 is equal to half the height of a character.
•
Font: The font used in the Legend.
•
Margin: Use OuterMarginLeft, OuterMarginRight, OuterMarginTop, or
OuterMarginBottom to set the margin between the left, right, top, or bottom side edge of
the control and the internal drawn elements. The values are specified in pixels.
•
Column Titles Visible: Use ColumnTitlesVisible to specify whether the column titles
are visible in the legend.
•
Column Titles Font: Use ColumnTitlesFont to change the attributes of the column titles
font. To change to a new font, specify a new IFontDisp object.
•
Background Transparent: Use the BackGroundTransparent property to specify whether
the background behind the legend shows through.
•
Background Color: Use BackGroundColor to get or set the background color of the
legend.
•
Selected Item Background Color: Use SelectedItemBackGroundColor to get or set the
background color of selected items in the legend.
•
Selected Item Font: The font of the selected item.
•
Show Column Line: Use ShowColumnLine to specify whether the line column is shown
in the legend.
•
Show Column Marker: Use ShowColumnMarker to specify whether the marker column
is shown in the legend.
•
Show Column X-Axis Title: Use ShowColumnXAxisTitle to specify whether the XAxis title column is shown in the legend.
•
Show Column Y-Axis Title: Use ShowColumnYAxisTitle to specify whether the YAxis title column is shown in the legend.
•
Show Column X-Value: Use ShowColumnXValue to specify whether the x value
column is shown in the legend. The value displayed is the last x value added to the
channel. The formatting of the text is control by the formatting of the X-Axis that the
channel is using.
•
Show Column Y-Value: Use ShowColumnYValue to specify whether the y value
column is shown in the legend. The value displayed is the last y value added to the
channel. The formatting of the text is control by the formatting of the Y-Axis that the
channel is using.
•
Show Column Y-Max: Use ShowColumnYMax to specify whether the Y-Maximum
Value for each channel is shown in the legend.
•
Show Column Y-Min: Use ShowColumnYMin to specify whether the Y Minimum
Value for each channel is shown in the legend.
•
Show Column Y-Mean: Use ShowColumnYMean to specify whether the Y Mean Value
for each channel is shown in the legend.
!
If you change previous data points, the YMax, YMin, and YMean values will
no longer be valid. To refresh these values if you change previous data points,
call GetYMax, GetYMin, and/or GetYMean to force a recalculation of these
values after making your chages.
223
ToolBar
•
Visible: Show or hide entire toolbar.
•
Object.
Object.
•
224
•
Zoom In/Out Factor: Use ZoomInOutFactor to get or set the Toolbar Zoom button
zoom factor. When your application user clicks on either the Zoom In or Zoom Out
buttons, or you use the toolbar methods DoButtonClickZoomIn or
DoButtonClickZoomOut, the chart axes will be zoomed according to this factor.
When the ScaleType is set to Linear...
To zoom in our out by 100% set the value to 2
To zoom in our out by 50% set the value to 1.5
A setting of 1 will have no effect, and the zoom in and out capability will be disabled.
(Zoom Value must always be greater or equal to 1)
When the ScaleType is set to Logarithmic...
This property has no effect. Log based scales always zoom in our out by 100%, or by a
factor of 2 .
225
•
Show: Determines whether a button is shown on the toolbar or not.
Button
Meaning
Resume Button: Resumes tracking on ALL axes
Pause Button: Pauses tracking for ALL axes
Axes Mode Buttons: Changes the mode that the axes are in
when using the mouse. The first icon puts the axes in scroll
mode. The second icon puts the axes in zoom mode.
Zoom In/Out Buttons: Zooms ALL axes in our out.
Select Button: Used for selecting items in the data view
area. Generates events that can be used by the programmer
to react to selection of items such as data points,
annotations, areas of the data view, etc.
Zoom Box Button: Allows the user to draw a "Zoom Box"
on the DataView area to zoom ALL axes.
Cursor Button: Show or hide all data cursors. Values for
each channel are displayed in a hint window next to the
cursor(s).
Edit Button: Brings up the Run-Time property editor for
the user to change most control properties.
Copy Button: Copies the current component image to the
Windows' clipboard.
Save Button: Brings up a dialog to allow the user to save
chart data to currently supported file types.
Print Button: Allows user to print image of chart to
printer. See Print properties for more information.
226
Data View
•
Object.
Object.
•
227
•
Background Transparent: Use BackGroundTransparent to specify whether the
background behind the data view shows through.
•
Background Color: Use BackGroundColor to get or set the background color of the data
view.
•
Grid Show: Use GridXAxisName to get or the name of the X-Axis used for displaying
X-Axis major and minor lines in the grid. Use GridLineShowXMajors and
GridLineShowXMinors to specify which ticks are used to draw grid lines.
Stacked Axes Note: If you are using stacked axes, you will probably want to set this
property to “<All>”. This string value will instruct the grid to draw to the major tick
lines for each individual X-Axis.
•
Grid X-Axis Name: Use GridXAxisName to get or the name of the X-Axis used for
displaying X-Axis major and minor lines in the grid. Use GridLineShowXMajors and
GridLineShowXMinors to specify which ticks are used to draw grid lines.
If you are using stacked axes, it is recommended that you use an additional invisible axis
to ensure that the grid lines extend over the entire Plot Data View area. If not, then the
grid lines will only be drawn to the X-Axis specified, and will not be drawn to areas
where the X-Axis has been restricted by the StartPercent and StopPercent properties of
that Axis.
•
Grid Y-Axis Name: Use GridXAxisName to get or the name of the Y-Axis used for
displaying Y-Axis major and minor lines in the grid. Use GridLineShowYMajors and
GridLineShowYMinors to specify which ticks are used to draw grid lines.
Stacked Axes Note: If you are using stacked axes, you will probably want to set this
property to “<All>”. This string value will instruct the grid to draw to the major tick
lines for each individual X-Axis.Line Color: Use GridLineColor to get or set the color of
the grid lines drawn in the data view.
•
Line Major Style: Use the GridLineMajorStyle property to get or set the line style of
grid lines drawn from major ticks (major ticks from axes specified by the
GridXAxisName and GridYAxisName properties)
Value
ipglsSolid
ipglsDash
ipglsDot
228
Meaning
A solid line
•
Line Minor Style: Use the GridLineMinorStyle property to get or set the line style of
grid lines drawn from minor ticks (minor ticks from axes specified by the
GridXAxisName and GridYAxisName properties)
Value
ipglsSolid
ipglsDash
ipglsDot
Meaning
A solid line
•
Show: Sets which lines are shown in the grid.
•
Show X-Major's: Use GridLineShowXMajors to specify whether the X-Axis major ticks
lines are shown in the grid.
•
Show Y-Major's: Use GridLineShowYMajors to specify whether the Y-Axis major ticks
•
Show X-Minor's: Use GridLineShowYMinors to specify whether the Y-Axis minor ticks
•
Show Y-Minors: Use GridLineShowYMinors to specify whether the Y-Axis minor ticks
Labels
229
•
•
•
Font: Use Font to change the font attributes of the Label Object text.
•
Caption: Use Caption to get or set the Label Object display text. To hide the caption, see
the Visible property of the Label Object .
Note: for backward compatibility, the TitleText property will always modify the Caption
property of Label Index 0.
•
Alignment: Set Alignment to specify how the text is aligned within the ClientRect of the
label object.
Value
iahCenter
iahLeft
iahRight
•
230
Meaning
Text is centered in the control.
Text is left-justified: Begins at the left edge of the control.
Text is right-justified: Ends at the right edge of the control.
Margin: Use Margin to get or set the margin between the Caption and the top, bottom,
left, and right of the Label Object. The Margin values is in percent of the title font height
or width.
Appendix B - ActiveX HTML Properties and Events
HTML Page Important Notes
Boolean Values:
TRUE
FALSE
= -1
= 0
Double Values:
Double values cannot be of greater precision than 4 decimal places. This is a limitation of the
streaming mechanism of Internet Explorer. This is generally a problem with Date/Time values
used in the axes properties. It is recommended that you calculate and set Date/Time Min and
Span values for axes (and any other property that you need greater than 4 decimal place
precision) in your HTML page loading code as a work-around.
Properties
Below, you will find all of the currently supported properties that can be streamed in from an HTML
page into the iPlotX component. Default values are provided. If you only need the default
properties, then you do not need these lines in your HTML Object tag code since the control will set
these default properties all by itself. You only need to include param tags for properties that differ
from the default. (Note: some HTML editors will automatically insert all of these streamed
properties for you. If you don’t need the default properties, simply delete the param lines. If you
used the built-in property editors in your HTML editor to set properties at design time, then leave in
the param lines if you are not sure which ones to remove or leave)
Array Properties Note: “Channel0” refers to the first channel and “Channel1” refers to the second
channel, and so on. All array properties (sub object properties) are coded with the number after the
array name, and are zero based. Please note that only the Axes and Channels support multiple items
at this time.
The following list shows the available param tags for our iPlot and iXYPlot components along with
their default values…
231
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
232
name="DataViewZHorz" value="1">
name="DataViewZVert" value="1">
name="XYAxesReverse" value="0">
name="OuterMarginLeft" value="5">
name="OuterMarginTop" value="5">
name="OuterMarginRight" value="5">
name="OuterMarginBottom" value="5">
name="PrintOrientation" value="1">
name="PrintMarginLeft" value="1">
name="PrintMarginTop" value="1">
name="PrintMarginRight" value="1">
name="PrintMarginBottom" value="1">
name="PrintShowDialog" value="-1">
name="UpdateFrameRate" value="60">
name="BackGroundColor" value="0">
name="BorderStyle" value="2">
name="AutoFrameRate" value="-1">
name="HintsShow" value="-1">
name="HintsPause" value="500">
name="HintsHidePause" value="2500">
name="TitleVisible" value="-1">
name="TitleText" value="Untitled">
name="TitleMargin" value="0.25">
name="TitleFont" value="Arial">
name="TitleFontColor" value="16777215">
name="UserCanEditObjects" value="-1">
name="LogFileName" value>
name="LogBufferSize" value="0">
name="OptionSaveAllProperties" value="0">
name="HintsFont" value="MS Sans Serif">
name="HintsFontColor" value="2147483656">
name="AnnotationDefaultFont" value="MS Sans Serif">
name="AnnotationDefaultFontColor" value="16777215">
name="AnnotationDefaultBrushStlye" value="0">
name="AnnotationDefaultBrushColor" value="16777215">
name="AnnotationDefaultPenStlye" value="0">
name="AnnotationDefaultPenColor" value="16777215">
name="AnnotationDefaultPenWidth" value="1">
name="DataViewZHorz" value="1">
name="DataViewZVert" value="1">
name="ChannelCount" value="1">
name="XAxisCount" value="1">
name="YAxisCount" value="1">
name="ToolBarCount" value="1">
name="LegendCount" value="1">
name="DataViewCount" value="1">
name="DataCursorCount" value="1">
name="LimitCount" value="1">
name="LabelCount" value="1">
name="TranslationCount" value="0">
name="ToolBar0.Name" value="Toolbar 1">
name="ToolBar0.Visible" value="1">
name="ToolBar0.Enabled" value="1">
name="ToolBar0.PopupEnabled" value="1">
name="ToolBar0.Horizontal" value="1">
name="ToolBar0.ZOrder" value="3">
name="ToolBar0.StartPercent" value="0">
name="ToolBar0.StopPercent" value="100">
name="ToolBar0.ShowResumeButton" value="1">
name="ToolBar0.ShowPauseButton" value="1">
name="ToolBar0.ShowAxesModeButtons" value="1">
name="ToolBar0.ShowZoomInOutButtons" value="1">
name="ToolBar0.ShowSelectButton" value="0">
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
name="ToolBar0.ShowZoomBoxButton" value="1">
name="ToolBar0.ShowCursorButton" value="1">
name="ToolBar0.ShowEditButton" value="1">
name="ToolBar0.ShowCopyButton" value="1">
name="ToolBar0.ShowSaveButton" value="1">
name="ToolBar0.ShowPrintButton" value="1">
name="ToolBar0.ZoomInOutFactor" value="2">
name="Legend0.Name" value="Legend 1">
name="Legend0.Visible" value="1">
name="Legend0.Enabled" value="1">
name="Legend0.PopupEnabled" value="1">
name="Legend0.Horizontal" value="0">
name="Legend0.ZOrder" value="2">
name="Legend0.StartPercent" value="0">
name="Legend0.StopPercent" value="100">
name="Legend0.MarginLeft" value="1">
name="Legend0.MarginTop" value="1">
name="Legend0.MarginRight" value="1">
name="Legend0.MarginBottom" value="1">
name="Legend0.BackGroundColor" value="8421504">
name="Legend0.BackGroundTransparent" value="1">
name="Legend0.SelectedItemBackGroundColor" value="65535">
name="Legend0.SelectedItemFont.Charset" value="1">
name="Legend0.SelectedItemFont.Color" value="0">
name="Legend0.SelectedItemFont.Height" value="-11">
name="Legend0.SelectedItemFont.Name" value="MS Sans Serif">
name="Legend0.SelectedItemFont.Pitch" value="0">
name="Legend0.SelectedItemFont.Style" value="0">
name="Legend0.SelectedItemFont" value="65535">
name="Legend0.ShowColumnLine" value="1">
name="Legend0.ShowColumnMarker" value="0">
name="Legend0.ShowColumnXAxisTitle" value="0">
name="Legend0.ShowColumnYAxisTitle" value="0">
name="Legend0.ShowColumnXValue" value="0">
name="Legend0.ShowColumnYValue" value="0">
name="Legend0.ShowColumnYMax" value="0">
name="Legend0.ShowColumnYMin" value="0">
name="Legend0.ShowColumnYMean" value="0">
name="Legend0.Font.Charset" value="1">
name="Legend0.Font.Color" value="16777215">
name="Legend0.Font.Height" value="-11">
name="Legend0.Font.Name" value="MS Sans Serif">
name="Legend0.Font.Pitch" value="0">
name="Legend0.Font.Style" value="0">
name="Legend0.Font" value="0">
name="Legend0.ColumnSpacing" value="0.5">
name="Legend0.RowSpacing" value="0.25">
name="Legend0.ColumnTitlesVisible" value="0">
name="Legend0.ColumnTitlesFont.Charset" value="1">
name="Legend0.ColumnTitlesFont.Color" value="16776960">
name="Legend0.ColumnTitlesFont.Height" value="-11">
name="Legend0.ColumnTitlesFont.Name" value="MS Sans Serif">
name="Legend0.ColumnTitlesFont.Pitch" value="0">
name="Legend0.ColumnTitlesFont.Style" value="1">
name="Legend0.ColumnTitlesFont" value="0">
name="Legend0.ChannelNameMaxWidth" value="0">
name="XAxis0.Name" value="X-Axis 1">
name="XAxis0.Visible" value="1">
name="XAxis0.Enabled" value="1">
name="XAxis0.PopupEnabled" value="1">
name="XAxis0.Horizontal" value="1">
name="XAxis0.ZOrder" value="0">
name="XAxis0.StartPercent" value="0">
233
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
234
name="XAxis0.StopPercent" value="100">
name="XAxis0.Min" value="0">
name="XAxis0.Span" value="100">
name="XAxis0.DesiredStart" value="0">
name="XAxis0.DesiredIncrement" value="0">
name="XAxis0.ReverseScale" value="0">
name="XAxis0.InnerMargin" value="5">
name="XAxis0.OuterMargin" value="5">
name="XAxis0.Title" value="X-Axis 1">
name="XAxis0.TitleMargin" value="0.25">
name="XAxis0.TitleFont.Charset" value="1">
name="XAxis0.TitleFont.Color" value="16777215">
name="XAxis0.TitleFont.Height" value="-13">
name="XAxis0.TitleFont.Name" value="Arial">
name="XAxis0.TitleFont.Pitch" value="0">
name="XAxis0.TitleFont.Style" value="1">
name="XAxis0.TitleFont" value="0.25">
name="XAxis0.TitleShow" value="0">
name="XAxis0.MajorLength" value="7">
name="XAxis0.MinorLength" value="3">
name="XAxis0.MinorCount" value="1">
name="XAxis0.LabelsMargin" value="0.25">
name="XAxis0.LabelsFont.Charset" value="1">
name="XAxis0.LabelsFont.Color" value="16777215">
name="XAxis0.LabelsFont.Height" value="-11">
name="XAxis0.LabelsFont.Name" value="MS Sans Serif">
name="XAxis0.LabelsFont.Pitch" value="0">
name="XAxis0.LabelsFont.Style" value="0">
name="XAxis0.LabelsFont" value="0.25">
name="XAxis0.LabelsPrecisionStyle" value="0">
name="XAxis0.LabelsPrecision" value="3">
name="XAxis0.LabelsMinLength" value="5">
name="XAxis0.LabelsMinLengthAutoAdjust" value="0">
name="XAxis0.LabelSeparation" value="2">
name="XAxis0.LabelsFormatStyle" value="0">
name="XAxis0.DateTimeFormat" value="hh:nn:ss">
name="XAxis0.ScaleLineShow" value="0">
name="XAxis0.ScaleLinesColor" value="16777215">
name="XAxis0.StackingEndsMargin" value="0.5">
name="XAxis0.ScaleType" value="0">
name="XAxis0.TrackingEnabled" value="1">
name="XAxis0.TrackingStyle" value="3">
name="XAxis0.TrackingAlignFirstStyle" value="2">
name="XAxis0.TrackingScrollCompressMax" value="0">
name="XAxis0.CursorPrecision" value="3">
name="XAxis0.CursorScaler" value="1">
name="XAxis0.ScrollMinMaxEnabled" value="0">
name="XAxis0.ScrollMax" value="100">
name="XAxis0.ScrollMin" value="0">
name="XAxis0.RestoreValuesOnResume" value="1">
name="XAxis0.MasterUIInput" value="0">
name="YAxis0.Name" value="Y-Axis 1">
name="YAxis0.Visible" value="1">
name="YAxis0.Enabled" value="1">
name="YAxis0.PopupEnabled" value="1">
name="YAxis0.Horizontal" value="0">
name="YAxis0.ZOrder" value="0">
name="YAxis0.StartPercent" value="0">
name="YAxis0.StopPercent" value="100">
name="YAxis0.Min" value="0">
name="YAxis0.Span" value="100">
name="YAxis0.DesiredStart" value="0">
name="YAxis0.DesiredIncrement" value="0">
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
name="YAxis0.ReverseScale" value="0">
name="YAxis0.InnerMargin" value="5">
name="YAxis0.OuterMargin" value="5">
name="YAxis0.Title" value="Y-Axis 1">
name="YAxis0.TitleMargin" value="0.25">
name="YAxis0.TitleFont.Charset" value="1">
name="YAxis0.TitleFont.Color" value="16777215">
name="YAxis0.TitleFont.Height" value="-13">
name="YAxis0.TitleFont.Name" value="Arial">
name="YAxis0.TitleFont.Pitch" value="0">
name="YAxis0.TitleFont.Style" value="1">
name="YAxis0.TitleFont" value="0.25">
name="YAxis0.TitleShow" value="0">
name="YAxis0.MajorLength" value="7">
name="YAxis0.MinorLength" value="3">
name="YAxis0.MinorCount" value="1">
name="YAxis0.LabelsMargin" value="0.25">
name="YAxis0.LabelsFont.Charset" value="1">
name="YAxis0.LabelsFont.Color" value="16777215">
name="YAxis0.LabelsFont.Height" value="-11">
name="YAxis0.LabelsFont.Name" value="MS Sans Serif">
name="YAxis0.LabelsFont.Pitch" value="0">
name="YAxis0.LabelsFont.Style" value="0">
name="YAxis0.LabelsFont" value="0.25">
name="YAxis0.LabelsPrecisionStyle" value="0">
name="YAxis0.LabelsPrecision" value="3">
name="YAxis0.LabelsMinLength" value="5">
name="YAxis0.LabelsMinLengthAutoAdjust" value="0">
name="YAxis0.LabelSeparation" value="2">
name="YAxis0.LabelsFormatStyle" value="0">
name="YAxis0.DateTimeFormat" value="hh:nn:ss">
name="YAxis0.ScaleLineShow" value="0">
name="YAxis0.ScaleLinesColor" value="16777215">
name="YAxis0.StackingEndsMargin" value="0.5">
name="YAxis0.ScaleType" value="0">
name="YAxis0.TrackingEnabled" value="1">
name="YAxis0.TrackingStyle" value="0">
name="YAxis0.TrackingAlignFirstStyle" value="3">
name="YAxis0.TrackingScrollCompressMax" value="0">
name="YAxis0.CursorPrecision" value="3">
name="YAxis0.CursorScaler" value="1">
name="YAxis0.ScrollMinMaxEnabled" value="0">
name="YAxis0.ScrollMax" value="100">
name="YAxis0.ScrollMin" value="0">
name="YAxis0.RestoreValuesOnResume" value="1">
name="YAxis0.MasterUIInput" value="0">
name="DataView0.Name" value="Data View 1">
name="DataView0.Visible" value="1">
name="DataView0.Enabled" value="1">
name="DataView0.PopupEnabled" value="1">
name="DataView0.Horizontal" value="0">
name="DataView0.ZOrder" value="0">
name="DataView0.StartPercent" value="0">
name="DataView0.StopPercent" value="100">
name="DataView0.Title" value>
name="DataView0.GridXAxisName" value="X-Axis 1">
name="DataView0.GridYAxisName" value="Y-Axis 1">
name="DataView0.GridShow" value="1">
name="DataView0.GridLineColor" value="32768">
name="DataView0.GridLineShowLeft" value="1">
name="DataView0.GridLineShowRight" value="1">
name="DataView0.GridLineShowTop" value="1">
name="DataView0.GridLineShowBottom" value="1">
235
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
236
name="DataView0.GridLineShowXMajors" value="1">
name="DataView0.GridLineShowXMinors" value="0">
name="DataView0.GridLineShowYMajors" value="1">
name="DataView0.GridLineShowYMinors" value="0">
name="DataView0.GridLineMajorStyle" value="0">
name="DataView0.GridLineMinorStyle" value="0">
name="DataView0.BackgroundTransparent" value="1">
name="DataView0.BackgroundColor" value="8421376">
name="Channel0.Name" value="Channel 1">
name="Channel0.Visible" value="1">
name="Channel0.Enabled" value="1">
name="Channel0.PopupEnabled" value="1">
name="Channel0.TitleText" value="Channel 1">
name="Channel0.Color" value="255">
name="Channel0.VisibleInLegend" value="1">
name="Channel0.RingBufferSize" value="0">
name="Channel0.TraceVisible" value="1">
name="Channel0.TraceLineStyle" value="0">
name="Channel0.TraceLineWidth" value="1">
name="Channel0.MarkersVisible" value="0">
name="Channel0.MarkersSize" value="3">
name="Channel0.MarkersStyle" value="0">
name="Channel0.MarkersAllowIndividual" value="0">
name="Channel0.MarkersPenColor" value="255">
name="Channel0.MarkersPenUseChannelColor" value="1">
name="Channel0.MarkersPenStyle" value="0">
name="Channel0.MarkersPenWidth" value="0">
name="Channel0.MarkersBrushColor" value="255">
name="Channel0.MarkersBrushUseChannelColor" value="1">
name="Channel0.MarkersBrushStyle" value="0">
name="Channel0.XAxisName" value="X-Axis 1">
name="Channel0.YAxisName" value="Y-Axis 1">
name="Channel0.XAxisTrackingEnabled" value="1">
name="Channel0.YAxisTrackingEnabled" value="1">
name="Channel0.LogFileName" value>
name="Channel0.LogBufferSize" value="0">
name="Channel0.Tag" value="0">
name="Channel0.Limits" value="0">
name="Channel0.FillEnabled" value="0">
name="Channel0.FillReference" value="0">
name="Channel0.FillStyle" value="0">
name="Channel0.FillColor" value="0">
name="Channel0.FillUseChannelColor" value="1">
name="Channel0.DigitalEnabled" value="0">
name="Channel0.DigitalReferenceStyle" value="0">
name="Channel0.DigitalReferenceLow" value="10">
name="Channel0.DigitalReferenceHigh" value="90">
name="Channel0.FastDrawEnabled" value="1">
name="Channel0.InterpolationStyle" value="0">
name="DataCursor0.Name" value="Cursor 1">
name="DataCursor0.Visible" value="0">
name="DataCursor0.Enabled" value="1">
name="DataCursor0.PopupEnabled" value="1">
name="DataCursor0.ChannelName" value="Channel 1">
name="DataCursor0.Style" value="0">
name="DataCursor0.Font.Charset" value="1">
name="DataCursor0.Font.Color" value="-2147483640">
name="DataCursor0.Font.Height" value="-11">
name="DataCursor0.Font.Name" value="MS Sans Serif">
name="DataCursor0.Font.Pitch" value="0">
name="DataCursor0.Font.Style" value="0">
name="DataCursor0.Font" value="0">
name="DataCursor0.Color" value="65535">
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
<param
name="DataCursor0.UseChannelColor" value="1">
name="DataCursor0.HintShow" value="1">
name="DataCursor0.HintHideOnRelease" value="0">
name="DataCursor0.HintOrientationSide" value="0">
name="DataCursor0.HintPosition" value="50">
name="DataCursor0.Pointer1Position" value="50">
name="DataCursor0.Pointer2Position" value="60">
name="DataCursor0.MenuItemVisibleValueXY" value="1">
name="DataCursor0.MenuItemVisibleValueX" value="1">
name="DataCursor0.MenuItemVisibleValueY" value="1">
name="DataCursor0.MenuItemVisibleDeltaX" value="1">
name="DataCursor0.MenuItemVisibleDeltaY" value="1">
name="DataCursor0.MenuItemVisibleInverseDeltaX" value="1">
name="DataCursor0.MenuItemCaptionValueXY" value="Value X-Y">
name="DataCursor0.MenuItemCaptionValueX" value="Value X">
name="DataCursor0.MenuItemCaptionValueY" value="Value Y">
name="DataCursor0.MenuItemCaptionDeltaX" value="Period">
name="DataCursor0.MenuItemCaptionDeltaY" value="Peak-Peak">
name="DataCursor0.MenuItemCaptionInverseDeltaX" value="Frequency">
name="Limit0.Name" value="Limit 1">
name="Limit0.Visible" value="1">
name="Limit0.Enabled" value="1">
name="Limit0.PopupEnabled" value="1">
name="Limit0.Color" value="255">
name="Limit0.LineStyle" value="0">
name="Limit0.LineWidth" value="0">
name="Limit0.FillStyle" value="0">
name="Limit0.XAxisName" value="X-Axis 1">
name="Limit0.YAxisName" value="Y-Axis 1">
name="Limit0.Style" value="1">
name="Limit0.Line1Position" value="50">
name="Limit0.Line2Position" value="50">
name="Label0.Name" value="Title">
name="Label0.Visible" value="1">
name="Label0.Enabled" value="1">
name="Label0.PopupEnabled" value="1">
name="Label0.Horizontal" value="1">
name="Label0.ZOrder" value="2">
name="Label0.StartPercent" value="0">
name="Label0.StopPercent" value="100">
name="Label0.MarginLeft" value="0">
name="Label0.MarginTop" value="0">
name="Label0.MarginRight" value="0">
name="Label0.MarginBottom" value="0.25">
name="Label0.Caption" value="Untitled">
name="Label0.Alignment" value="0">
name="Label0.Font.Charset" value="1">
name="Label0.Font.Color" value="16777215">
name="Label0.Font.Height" value="-19">
name="Label0.Font.Name" value="Arial">
name="Label0.Font.Pitch" value="0">
name="Label0.Font.Style" value="1">
name="Label0.Font" value="0">
237
VBScript Events
Events in VBScript under Internet Explorer are identical to their counterparts in Visual Basic or VBA
except that VBScript does not support variable types and some events (such as drag and focus events).
Internet Explorer VBA does not support variable types. All variables are assumed to be Variants, so you
will not find any “as” operators in the event declarations.
<SCRIPT ID=clientEventHandlersVBS LANGUAGE=vbscript>
<!-Sub iPlotX1_OnAfterPrint()
End Sub
Sub iPlotX1_OnBeforePrint()
End Sub
Sub iPlotX1_OnClick()
End Sub
Sub iPlotX1_OnClickAnnotation(ByVal Index)
End Sub
Sub iPlotX1_OnClickDataPoint(ByVal ChannelIndex, ByVal DataIndex)
End Sub
Sub iPlotX1_OnDataCursorChange(ByVal Index)
End Sub
Sub iPlotX1_OnDblClick()
End Sub
Sub iPlotX1_OnMouseDown(ByVal Button, ByVal Shift, ByVal X, ByVal Y)
End Sub
Sub iPlotX1_OnMouseMove(ByVal Shift, ByVal X, ByVal Y)
End Sub
Sub iPlotX1_OnMouseUp(ByVal Button, ByVal Shift, ByVal X, ByVal Y)
End Sub
Sub iPlotX1_OnXAxisCustomizeLabel(ByVal Index, ByVal Value, ALabel)
End Sub
Sub iPlotX1_OnXAxisMinChange(ByVal Index, ByVal OldValue, ByVal NewValue)
End Sub
Sub iPlotX1_OnXAxisSpanChange(ByVal Index, ByVal OldValue, ByVal NewValue)
238
End Sub
Sub iPlotX1_OnYAxisCustomizeLabel(ByVal Index, ByVal Value, ALabel)
End Sub
Sub iPlotX1_OnYAxisMinChange(ByVal Index, ByVal OldValue, ByVal NewValue)
End Sub
Sub iPlotX1_OnYAxisSpanChange(ByVal Index, ByVal OldValue, ByVal NewValue)
End Sub
-->
</SCRIPT>
JavaScript Events
If you prefer to use JavaScript in your HTML code, then you will need to first “map” the event you wish
to use with the iPlotX component to a particular event handler as follows. Note that this is a hack in
Internet Explorer to allow JavaScript to be used with the ActiveX component. Netscape Navigator and
other browsers do not support ActiveX controls as this time.
<SCRIPT LANGUAGE=javascript FOR=iPlotX1
<!-iPlotX1_OnAfterPrint();
//-->
</SCRIPT>
<!-iPlotX1_OnBeforePrint();
//-->
</SCRIPT>
<!-iPlotX1_OnClick();
//-->
</SCRIPT>
<!-iPlotX1_OnClickAnnotation(Index);
//-->
</SCRIPT>
<!-iPlotX1_OnClickDataPoint(ChannelIndex,
//-->
</SCRIPT>
<!-iPlotX1_OnDataCursorChange(Index);
//-->
</SCRIPT>
<!-iPlotX1_OnDblClick();
//-->
</SCRIPT>
EVENT="OnAfterPrint">
EVENT="OnBeforePrint">
EVENT="OnClick">
EVENT="OnClickAnnotation(Index)">
EVENT="OnClickDataPoint(ChannelIndex, DataIndex)">
DataIndex);
EVENT="OnDataCursorChange(Index)">
EVENT="OnDblClick">
EVENT="OnMouseDown(Button, Shift, X, Y)">
239
<!-iPlotX1_OnMouseDown(Button, Shift, X, Y);
//-->
</SCRIPT>
<SCRIPT LANGUAGE=Jscript FOR=iPlotX1 EVENT="OnMouseMove(Shift, X, Y)">
<!-iPlotX1_OnMouseMove(Shift, X, Y);
//-->
</SCRIPT>
<SCRIPT LANGUAGE=javascript FOR=iPlotX1 EVENT="OnMouseUp(Button, Shift, X, Y)">
<!-iPlotX1_OnMouseUp(Button, Shift, X, Y);
//-->
</SCRIPT>
<SCRIPT LANGUAGE=javascript FOR=iPlotX1 EVENT="OnXAxisCustomizeLabel(Index, Value, ALabel)">
<!-iPlotX1_OnXAxisCustomizeLabel(Index, Value, ALabel);
//-->
</SCRIPT>
<SCRIPT LANGUAGE=javascript FOR=iPlotX1 EVENT="OnXAxisMinChange(Index, OldValue, NewValue)">
<!-iPlotX1_OnXAxisMinChange(Index, OldValue, NewValue);
//-->
</SCRIPT>
<SCRIPT LANGUAGE=javascript FOR=iPlotX1 EVENT="OnXAxisSpanChange(Index, OldValue, NewValue)">
<!-iPlotX1_OnXAxisSpanChange(Index, OldValue, NewValue);
//-->
</SCRIPT>
<SCRIPT LANGUAGE=javascript FOR=iPlotX1 EVENT="OnYAxisCustomizeLabel(Index, Value, ALabel)">
<!-iPlotX1_OnYAxisCustomizeLabel(Index, Value, ALabel);
//-->
</SCRIPT>
<SCRIPT LANGUAGE=javascript FOR=iPlotX1 EVENT="OnYAxisMinChange(Index, OldValue, NewValue)">
<!-iPlotX1_OnYAxisMinChange(Index, OldValue, NewValue);
//-->
</SCRIPT>
<SCRIPT LANGUAGE=javascript FOR=iPlotX1 EVENT="OnYAxisSpanChange(Index, OldValue, NewValue)">
<!-iPlotX1_OnYAxisSpanChange(Index, OldValue, NewValue);
//-->
</SCRIPT>
Events that have parameters must be enclosed within quotation marks.
240
Now include a separate script tag to include the event handlers, and the code you wish to run when that
event is fired…
<SCRIPT ID=clientEventHandlersJS LANGUAGE=javascript>
<!-function iPlotX1_OnAfterPrint()
{
//Add your code here
};
function iPlotX1_OnBeforePrint()
{
};
function iPlotX1_OnClick()
{
};
function iPlotX1_OnClickAnnotation(Index)
{
};
function iPlotX1_OnClickDataPoint(ChannelIndex, DataIndex)
{
};
function iPlotX1_OnDataCursorChange(Index)
{
};
function iPlotX1_OnDblClick()
{
};
function iPlotX1_OnMouseDown(Button, Shift, X, Y)
{
};
function iPlotX1_OnMouseMove(Shift, X, Y)
{
};
function iPlotX1_OnMouseUp(Button, Shift, X, Y)
{
};
241
function iPlotX1_OnXAxisCustomizeLabel(Index, Value, ALabel)
{
};
function iPlotX1_OnXAxisMinChange(Index, OldValue, NewValue)
{
};
function iPlotX1_OnXAxisSpanChange(Index, OldValue, NewValue)
{
};
function iPlotX1_OnYAxisCustomizeLabel(Index, Value, ALabel)
{
};
function iPlotX1_OnYAxisMinChange(Index, OldValue, NewValue)
{
};
function iPlotX1_OnYAxisSpanChange(Index, OldValue, NewValue)
{
};
//-->
</SCRIPT>
LPK File Tutorial
Web Page ActiveX Licensing: What is an LPK File?
An LPK file is a file that licenses our ActiveX controls when running on a Microsoft Internet
Explorer Web Browser. This file must be created for all ActiveX components that require
licensing, regardless of manufacturer.
242
Steps to create an LPK File...
1. Make sure you have installed our ActiveX components using our Product Installer (either from
the CD-ROM or downloaded version). If you have any reason to believe that our components are
missing license information on your system, simply open our installer from the Windows
Add/Remove Control Panel and select the REPAIR option to fix our ActiveX licensing.
2. Obtain the Microsoft LPK File Generation Tool either from your Visual Studio Installation, from
the Microsoft Internet Explorer API Pack, or from Microsoft's Download File Section of their
website (Download: Microsoft LPK Tool [74.5 KB]). This program is the only program that can
generate LPK files and is provided by Microsoft.
243
3. Open the LPK Tool and select the Iocomp Components you will be using on the web page. Also
select other ActiveX controls that you will be using on the same web page that require licensing.
You can only have one LPK file per web page, so you will need to select all ActiveX controls
that will be used. We recommend that you create a single LPK file for all web pages on your site
for simplicity. Click on the "ADD ->" button when you are done.
4. Click the "Save & Exit" button to generate the LPK file.
244
5. You can name the LPK file anything you wish. We recommend that you don't include spaces or
non-standard characters in the name as to avoid issues with different server operating systems
(remember that our ActiveX components can be placed on any web server OS, they just have to
run on a Windows Web Browser client).
6. Copy the LPK file to a location on your web server. If you are just creating a single web page,
we recommend that you place the LPK file in the same folder as the web page. If you are
creating multiple web pages, we recommend that you place the LPK file in a common folder off
of the root of your web server, such as /download.
!
The LPK file must be located on the same server as where the HTML
page is stored/generated.
You can only have one LPK file per web page. Therefore, you will need
to include all licenses for all ActiveX components (whether they are from
Iocomp or some other Third Party ActiveX company) in the single LPK
file. We recommend that you make one single LPK file for use on your
website to make things easier.
245
Steps to integrate the LPK File into your web page...
1. Place the following block of code, substituting the name of your LPK file, at the top the body
section of your web page...
<html>
<head>
<title>LPK File Example Page</title>
</head>
<body>
<object CLASSID="clsid:5220cb21-c88d-11cf-b347-00aa00a28331" VIEWASTEXT>
<param name="LPKPath" value="/download/MyLPKfile.lpk">
</object>
...include all ActiveX component object tags only after this line...
</body>
</html>
Note:
2. That's it! Check out our other Internet Explorer Examples for information about integrating
ActiveX components into the web page.
!
246
The CLASSID must always be the value specified above. This is the
CLASSID of the Microsoft License Manager component, which
provides licensing services to ActiveX components that require
licensing. This CLASSID is the same for all versions of Microsoft
Internet Explorer You can only have one LPK file entry per web page!
Appendix C -- What is DateTime Format?
Date/Time format is commonly used in Microsoft products such as Microsoft Excel and is
based on a floating-point value to represent a date or time value...
Date/Time Calculations
1 day
=1
1 hour = 1/24
1 minute = 1/(24*60)
1 second = 1/(24*60*60)
1 millisecond = 1/(24*60*60*1000)
!
Visual Basic: the following formula should be used when using
Visual Basic: (1/(24#*60#*60#)). The # symbols force Visual Basic
to treat the numbers as floating point values, otherwise you will
generate a compiler error since VB is trying to use Integer math.
You may find it helpful to setup a constant in your program for this
calculation to represent one second...
Const OneSecond As Double = 1 / (24# * 60# * 60#)
!
C++ Compiler: the following formula should be used when using
C++ Compilers such as Visual C++ or Borland C++ Builder and
others: (1.0/(24.0*60.0*60.0)). Specifying the numerical values as
floating point numbers forces the C++ compiler to use floating-point
math, and not integer math, which would result in incorrect results.
Visual Layout Manager: if you use the built-in property editor, notice
the button next to values which can accept date-time values. If you
click on the button, you will be able to access a calculator that will do
the above calculations for you when entering values.
To specify a particular date such as March 12, 2000, you need to specify a decimal value that
represents how much time has elapsed since December 30, 1899 at 12:00am...
December 30, 1899 12:00am = 0
January 1, 1900 = 1
March 12, 2000 = 36597
December 31, 9999 = 2958525
March 12, 2000 12:00pm = 36597.5
247
March 12, 2000 6:00pm = 36597.75
By default, the axes span in our charting components is set to a value of 10. If you enable the
date/time format…
iComponent.Xaxis(0).LabelsFormatStyle = iptfDateTime
iComponent.Yaxis(0).LabelsFormatStyle = iptfDateTime
in a particular axis, then the axis scale would correspond to a range of 10 days. If you are
plotting data to the chart component with such a large scale, it would appear that the chart was
not working as it would take 10 days to plot from one side of the axis to the other!
For Example:
Let's say you want to specify an X-Axis scale between 0-10 seconds. You would use the formula
(1/(24*60*60)) *10 to obtain the time/date value for ten seconds. You would set the X-Axis min value
to 0 and the X-Axis max value to the calculated formula value.
Don’t forget to set the AxisLabelFormatStyle and DateTimeFormat string properties for DateTime
mode.
iComponent.Xaxis(0).LabelsFormatStyle = iptfDateTime
iComponent.Xaxis(0).DateTimeFormat
= "nn:ss:zzz"
Here are some sample DateTimeFormat strings that can be used to format your date and time values in
the axis. You can make other combinations for this string if you need. Refer to the table on the next
page for custom formats.
Format String
d mmm hh:nn:ssam/pm
d mmm hh:nn:ss
m/d hh:nn:ssam/pm
m/d hh:nn:ss
d mmm hh:nnam/pm
d mmm hh:nn
hh:nn:ss.zzzz
Example
1 May 12:01:32am
1 May 22:01:32
2/28 12:01:32am
2/28 22:01:32
1 May 12:01 am
1 May 22:01
22:01:32.254
Month (M)
The letter "M" must be uppercase to distinguish months from minutes.
Picture item
M
MM
248
Displays the month as
A number without a leading 0 (zero) for single-digit months. For
example, July is "7".
A number with a leading 0 (zero) for single-digit months. For example,
July is "07".
MMM
MMMM
A three-letter abbreviation. For example, July is "Jul".
The full name of the month.
Day (d)
Displays the day of the month or the day of the week. The letter "d" can be either uppercase or
lowercase.
Picture item
d
dd
ddd
dddd
Displays the day of the month or week as
A number without a leading 0 (zero) for single-digit days. For
example, the sixth day of the month is displayed as "6".
A number with a leading 0 (zero) for single-digit days. For example,
the sixth day of the month is displayed as "06".
A three-letter abbreviation. For example, Tuesday is displayed as
"Tue".
The full name of the day of the week.
Year (y)
Displays the year as two or four digits. The letter "y" can be either uppercase or lowercase.
Picture item
yy
yyyy
Displays the year as
Two digits with a leading 0 (zero) for years 01 through 09. For
example, 1995 is displayed as "95", and 2006 is displayed as "06".
Four digits.
Special
These are special characters used in the format string that are supported by the labels.
Picture item
zzz
Displays the year as
Milliseconds
249
Appendix E -- Frequently Asked Questions
Below, you will find some frequently asked questions and specific, real-world situations that our
customers have been asking about our Plot Components…
Q:
A:
Q:
A:
For more information, examples, and FAQs, check out our examples and FAQ sections of our support
website…
Support: http://www.iocomp.com/support
FAQ: http://www.iocomp.com/support/faq
Examples: http://www.iocomp.com/support/examples
250
Index
251

Iocomp Plot Pack Manual

Transcription

Similar documents

food plot program

House in Scheibbs

Building Plot, New Fargie, Glenfarg, Perthshire, PH2 9QT

Kolovraty - pozemek

Offers over £60000 133 Clachtoll, Lairg, IV27 4JD

Indraprastha Broucher

Chancey - George R. Stuart Elementary

Pata- Olhos dágua Ref: V022 Price: € 649.000 Lovely villa on

Casa Nicole Pollensa