Long SetPlotAttribute (LPCTSTR Attribute, LPCTSTR Value);
Available (from release):
stOCX (V4-0), stPro Automation (V4-0)
Return Value:
Nonzero if successful otherwise 0.
Parameters:
Name: |
Description: |
Attribute |
The name of the Plot attribute that is to be set. |
Value |
The value to which the Plot attribute is to be set. |
Remarks:
Call this function to customize the specific settings for the active plot.
Attribute information:
The following attributes can be set for the active plot.
Attribute Name: |
Attribute Value(s): |
Description: |
Updated: |
"APPLY TO GROUP" |
"YES" "NO" |
Controls whether the PEN OVERLAP and PEN ORDERING controls are applied not only to Pens within a Scale Group, but across Scale Groups as well. |
Immediate. |
"AUTO SCALE STRATEGY" |
"FULL RANGE" "STDEV" |
Dictates the algorithm that is used to scale pens in Auto scale mode. |
Immediate. |
"COMPRESSION" |
"SINGLEPOINT" "AVERAGE" "MINIMUM" "MAXIMUM" "MIN/MAX" "MIN/MAX/AVG"
|
Sets the type of Plot Compression to implement when the time period dictates that there are more data items than pixels.. |
Immediate |
"DISPLAY MASK" |
displaymask |
Set the required display mask for the active plot. Note: See SetDisplayMask for details on the available options. |
Immediate |
"DURATION" |
Numeric |
Set the Plot Duration to the period specified (in seconds). |
Immediate |
"LEFT AXIS" and "RIGHT AXIS" |
pen handle (numeric) |
Set the appropriate Y-axis using the supplied pen handle. |
Immediate |
"LEFT AXIS NAME" and "RIGHT AXIS NAME" |
dl,item name |
Set the appropriate Y-Axis using the supplied item name. |
Immediate |
"LINE INTERPOLATION" |
"STEP" "LINE" "STEPDATA" |
Specify whether you wish stPro to behave like a strip chart emulator. |
Immediate |
"ONSCAN" |
"YES" "NO" |
Set the Plot Scan Status. |
Immediate |
"PEN ORDERING" |
"ASCENDING" "DESCENDING" |
Sets the order in which pens set to Auto Scale mode are added to the plot. Note: Selecting "Ascending" will add Pen 1 at the bottom of the plot and Pen 2 above it, etc. Choosing "Descending" will add Pen 1 at the top of the plot and Pen 2 below it, etc. |
Immediate |
"PEN OVERLAP" |
Percentage - 0 to 100 |
The amount by which the scales for pens in "Auto" scale mode should overlap. Tip: A setting of 100% means the pens will all be centered vertically around the middle of the plot. Tip: A setting of 0% means each pen will have its own 'band' on the plot and will not overlap with the adjacent pens. |
Immediate |
"PEN POINTERS" |
"YES" "NO" |
Sets whether to display Pen Pointers within the active plot. |
Immediate |
"PREVIEW WIDTH" |
Numeric |
Set the width for the Preview Pane.
Note: If the value is between 0 and 1, it is assumed to be a percentage. If the value is greater than 1, it is assumed to be in pixels. |
Immediate |
"RADAR ITEMS" |
Numeric |
The number of items to display on each axis for Radar plots. |
Immediate |
"SCALE LINES" |
"2" "3" "4" "5" "6" "7" "8" "9" "10" |
Sets the number of Y-axis scale lines for the active plot. |
Immediate |
"SCROLL FORWARD LINE" and "SCROLL BACK LINE" |
None |
Requests that the Plot be scrolled forwards or back by a single comb point. |
Immediate |
"SCROLL FORWARD PAGE" and "SCROLL BACK PAGE" |
None |
Requests that the Plot be scrolled forwards or back by a single page. |
Immediate |
"SDR" |
* |
Set the SDR for the plot to the specified value. |
Immediate |
"SHOW TITLE" |
"Yes" "No" |
Render the specified Plot Title (if any) within the plot window.
Tip: Use the "TITLE SIZE" and "TITLE ALIGN" attributes to control the size and location of the title within the plot window. |
Immediate |
"SKIP" |
Numeric |
Set the Skip count for the active plot. |
Immediate |
"START" and "END" |
date,local |
Set the start or end time for the plot to the date specified. Note: 'date' is of the format 'YYYY/MM/DD HH:MM:SS'. Note: 'local' should be either "YES" or "NO" and defines whether the specified time is in local format. If omitted, UTC (the default) is assumed. Tip: Fields that contain a delimiter are displayed using the default Field delimiter of ','. If SetDelimiter has been used, then the user should substitute the ',' for the user specified delimiter. |
Immediate |
"STYLE" |
"STRIP CHART" "RADAR" "X/Y SCATTER" "X/Y LINE" "STACKED" |
Set the required Plot style for the active plot. |
Immediate |
"TITLE" |
* |
Set the Plot Title to the value specified. |
Immediate |
"TITLE ALIGN" |
"Top-left" "Top-Center" "Top-Right" "Middle-left" "Middle-Center" "Middle-Right" "Bottom-left" "Bottom-Center" "Bottom-Right” |
Set the position of the Plot Title within the Plot window when the "SHOW TITLE" attribute is to "YES". |
Immediate |
"TITLE SIZE" |
"1" "2" "3" "4" "5"
|
Set the size of the Plot Title within the Plot window when the "SHOW TITLE" attribute is to "YES". |
Immediate |
Note: Attributes and Values are NOT case sensitive.