CxFmsHistoryGraphCtrl Properties
The CxFmsHistoryGraphCtrl object contains the following properties. This control displays data in Contract time (C).
General Properties
Browse by letter: A B C D E F H M P R S U
| Property | SubType | Read Only | Description |
|---|---|---|---|
|
Integer |
No |
Returns/sets the appearance of the object boundary Possible values for this property are as follows.
Default value is 0 - Flat |
|
|
String |
No |
Note: This property is only used if the UseSessionOptions property is set to 0 - No. Returns/sets the starting date of the FMS History Graph This string can be in one of the following forms.
Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control. Default value is T-7 |
|
|
Integer |
No |
Returns/sets the border style Possible values for this property are as follows.
Default value is 0 - None |
|
|
Boolean |
No |
Returns/sets whether or not the user can select multiple Nodes in the Node chooser Possible values for this property are as follows.
Default value is 1 - Yes |
|
|
String |
No |
Returns/sets the filter to be used when retrieving Nodes Wildcard values * (multiple character) and ? (single character) are supported. Wildcards can be used in any part of the string to specify that any character or set of characters is allowed in its place. Example A filter string of "*Test*" will retrieve all Nodes with the word "Test" somewhere in the string, such as "TestDevice" or "MyTestDevice" or "Device001Test". Default value is * (multiple character wildcard) |
|
|
Integer |
No |
Returns/sets the Node property that will be filtered by the string specified in the ChooserFilterString property Possible values for this property are as follows.
Default value is 0 - Name |
|
|
String |
No |
Returns/sets the group currently selected in the Node chooser’s Group combo box |
|
|
Integer |
No |
Returns/sets the Node category currently selected in the Node chooser’s Node category combo box Possible values for this property are as follows.
Default value is 8 - Node_Category2_Gas_Device |
|
|
Boolean |
No |
Returns/sets whether or not the Node chooser’s Node category combo box is visible Possible values for this property are as follows.
Default value is 1 - Yes |
|
|
Integer |
No |
Returns/sets the primary sort column of the Node chooser’s Node list Possible values for this property are as follows.
Default value is 2 - Name ascending |
|
|
String |
No |
Returns/sets the Site.Service currently selected in the Node chooser’s FMS combo box |
|
|
Boolean |
No |
Returns/sets whether or not the Node chooser’s FMS combo box is visible Possible values for this property are as follows.
Default value is 1 - Yes |
|
|
String |
No |
Returns/sets the XML specifying the custom FMS commands configured for the control Another way to configure this property is to use the control’s property page. |
|
|
Integer |
No |
Returns/sets how colors are applied on the FMS History Graph, whether to individual Nodes or based on acceptability (data quality) level Possible values for this property are as follows.
Default value is 0 - Single Node |
|
|
String |
No |
Returns/sets the XML specifying the colors that will appear on the FMS History Graph Another way to configure this property is to use the control’s property page. |
|
|
Integer |
No |
Returns/sets the number of decimal places that will be shown in the values displayed by the FMS History Graph. Acceptable values include 0 - 7 decimal places. Default value is 4 |
|
|
String |
No |
Note: This property is only used if the UseSessionOptions property is set to 0 - No. Returns/sets the ending date of the FMS History Graph This string can be in one of the following forms.
Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control. Default value is T |
|
|
StdFont |
No |
Returns/sets the font used by the FMS History Graph control Click … to access the Font dialog box to make font selections. Default value is MS Shell Dlg. |
|
|
Integer |
No |
Returns/sets the font size used by the FMS History Graph Possible values for this property are as follows.
Default value is 1 - Medium |
|
|
Integer |
No |
Note: This property is only used if the UseHeightOverride property is set to 1 - Yes. Returns/sets what the height, in pixels, of the Value Table will be, if the default value is overridden Default value is 0 - No value |
|
|
Integer |
No |
Returns/sets whether Station Meters will be displayed in the FMS History Graph as Stations or Devices Possible values for this property are as follows.
Default value is 3 - Stations |
|
|
String |
No |
Note: This property is only used if the UsePIT property is set to 1 - Yes. Returns/sets the Point in Time date and time of the FMS History Graph control This string can be in one of the following forms.
Default value is T, date and time today. See Using the Home Menu for more information about PIT mode. |
|
|
String |
No |
Returns/sets the XML specifying which process variables will be displayed in the FMS History Graph Another way to configure this property is to use the control’s property page. |
|
|
Integer |
No |
Return/sets the span of each record displayed in the FMS History Graph Possible values for this property are as follows.
Default value is 9999 - Native for Device data view, 60 - Hourly for Station data view |
|
|
String |
No |
Note: This property is only used if the UseSessionOptions property is set to 1 - Yes. Returns/sets the Session starting date for the time window displayed in the control This string can be in one of the following forms.
Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control. |
|
|
String |
No |
Note: This property is only used if the UseSessionOptions property is set to 1 - Yes. Returns/sets the Session ending date for the time window displayed in the control This string can be in one of the following forms.
Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control. |
|
|
String |
No |
Note: This property is only used if the UseSessionNode property is set to 1 - Yes. Returns/sets the Session Node tag, which specifies the active Node in the FMS Configuration control This tag must be in the form SITE.SERVICE|ID (for example, TEST.FMS|2540). Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control. |
|
|
Boolean |
No |
Returns/sets whether or not the Chooser pane will be displayed in the control Possible values for this property are as follows.
Default value is 1 - Yes |
|
|
Boolean |
No |
Return/sets whether or not a process variable legend will be displayed in the FMS History Graph Possible values for this property are as follows.
Default value is 1 - Yes |
|
|
Boolean |
No |
Returns/sets whether or not the Options pane will be displayed in the control Possible values for this property are as follows.
Default value is 1 - Yes |
|
|
String |
No |
Returns/sets the unit set used to determine the units of each FMS data item in the FMS History Graph Another way to configure this property is to use either the control’s property page or to use the Options page on the FMS History Graph. Default value is the <Default> unit set |
|
|
Boolean |
No |
Returns/sets whether or not the HeightOverride property will be used Possible values for this property are as follows.
Default value is 0 - No |
|
|
Boolean |
No |
Returns/sets whether or not the PITDateTime property will be used Possible values for this property are as follows.
Default value is 0 - No |
|
|
Boolean |
No |
Returns/sets whether or not the SessionNodeTag property will specify the active Node in the FMS History Graph If this property is set to 0 - No, the FMS History Graph will present a Chooser page for selection of the active Node. Possible values for this property are as follows.
Default value is 1 - Yes |
|
|
Boolean |
No |
Returns/sets whether or not the SessionBeginDate and SessionEndDate properties will be used in place of the BeginDate and EndDate properties Possible values for this property are as follows.
Default value is 1 - Yes |


