BSTR GetPlotAttribute (LPCTSTR Attribute);
Available (from release):
stOCX (V4-0), stPro Automation (V4-0)
Return Value:
The value of the requested Attribute if successful, otherwise an empty string.
Parameters:
|
Name: |
Description: |
|
Attribute |
The name of the Plot attribute that is to be fetched. |
Remarks:
Call this function to determine the settings for the active plot.
Attribute information:
The following attributes can be retrieved for the active plot.
|
Attribute Name: |
Attribute Value(s): |
Description: |
|
"COMPRESSION" |
"SINGLEPOINT" "AVERAGE" "MINIMUM" "MAXIMUM" "MIN/MAX" "MIN/MAX/AVG"
|
Gets the type of Plot Compression that will be used when the time period dictates that there are more data items than pixels.. |
|
"DATASOURCE" |
* |
Gets the name of the plots Data Source. |
|
"DISPLAY MASK" |
displaymask |
Gets the display mask for the active plot. Note: See GetDisplayMask for details on the return values. |
|
"DURATION" |
Numeric |
Gets the Plot Duration (in seconds). |
|
"LEFT AXIS" and "RIGHT AXIS" |
pen handle,dl,item |
Gets details of the appropriate Y-axis label.
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. |
|
"ONSCAN" |
"YES" "NO" |
Gets the Plot Scan Status. |
|
"PEN POINTERS" |
"YES" "NO" |
Gets whether Pen Pointer have been enabled for the active plot. |
|
"PREVIEW" |
"YES" "NO" |
Gets whether the Preview Pane should be displayed. |
|
"PREVIEW MODE" |
"INCREMENTAL" "SCROLL" |
Gets the mode of operation for the Preview Pane. |
|
"PREVIEW WIDTH" |
Numeric,mode |
Gets the width of the Preview Pane.
Note: Mode indicates whether the width is a percentage (%) of the plot width, or is in an absolute width in pixels (px). |
|
"SCALE LINES" |
"2" "3" "4" "5" "6" "7" "8" "9" "10" |
Gets the number of Y-axis scale lines for the active plot. |
|
"SDR" |
* |
Gets the name of the source SDR for the plot. |
|
"SKIP" |
Numeric |
Gets the Skip count for the active plot. |
|
"START" and "END" |
date |
Gets the start or end time for the Plot (in UTC). Notes: 'date' is of the format 'YYYY/MM/DD HH:MM:SS'. |
|
"STYLE" |
"STRIP CHART" "RADAR" "X/Y SCATTER" "X/Y LINE" "STACKED" |
Gets the Plot style for the active plot. |
|
"TITLE" |
* |
Gets the Plot Title. |
Note: Attributes are NOT case sensitive.