Scripting > CxHmiFms > CxFmsHistoryGraphCtrl Object > CxFmsHistoryGraphCtrl Properties

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

Appearance

Integer

No

Returns/sets the appearance of the object boundary. Possible values for this property are as follows.

  • 0 – Flat
  • 1 – 3D

Default value is 0 - Flat

BeginDate

String

No

Returns/sets the starting date of the FMS History Graph.

This string can be in one of the following forms.

  • Absolute date, for example, 1/31/2019
  • Relative date, for example, T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

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

BorderStyle

Integer

No

Returns/sets the border style. Possible values for this property are as follows.

  • 0 - None
  • 1 - Fixed single border

Default value is 0 - None

ChooserAllowMultiSelect

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.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

ChooserFilterString

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)

ChooserFilterType

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.

  • 0 – Name
  • 1 – Description
  • 2 – ID

Default value is 0 - Name

ChooserGroupSelection

String

No

Returns/sets the group currently selected in the Node chooser’s Group combo box.

ChooserNodeCategorySelection

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.

  • 1 – Node6_Category_Device
  • 8 – Node6_Category_Gas_Device
  • 9 – Node6_Category_Liquid_Device
  • 3 – Node6_Category_Station

Default value is 8 - Node6_Category_Gas_Device

ChooserNodeCategoryVisible

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.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

ChooserPrimarySortColumn

Integer

No

Returns/sets the primary sort column of the Node chooser’s Node list.

Possible values for this property are as follows.

  • 0 - Type ascending
  • 2 - Name ascending
  • 3 - Description ascending
  • 4 - Type descending
  • 5 - Name descending
  • 6 - Description descending

Default value is 2 - Name ascending

ChooserSiteServiceSelection

String

No

Returns/sets the Site.Service currently selected in the Node chooser’s FMS service combo box.

ChooserSiteServiceVisible

Boolean

No

Returns/sets whether or not the Node chooser’s FMS service combo box is visible. Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

CmdDefinitionXml

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.

ColorMode

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.

  • 0 - Single Node
  • 1 - Acceptability

Default value is 0 - Single Node

ColorXml

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.

DecimalPrecision

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

EndDate

String

No

Returns/sets the ending date of the FMS History Graph. This string can either be in the form of an Absolute date, for example, 1/31/2019, or a Relative date, for example, T (today), T-14 (14 days prior to today), or T+1 (one day following today).

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

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

Font

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.

FontSize

Integer

No

Returns/sets the font size used by the FMS History Graph. Possible values for this property are as follows.

  • 0 - Large
  • 1 - Medium
  • 2 - Small

Default value is 1 - Medium

HeightOverride

Integer

No

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

Note: This property is only used if the UseHeightOverride property is set to 1 - Yes.

MeterStationView

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.

  • 8 – Gas_Devices_Mode
  • 3 – Stations_Mode

Default value is 3 - Station_Mode

PITDateTime

String

No

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.

  • Absolute Date/Time (for example, 1/31/2019 7:10:14 AM)
  • Relative Date/Time (for example, y-1 m-2 d=15 H=5 M=30 S=0)
  • Relative Day, which is an offset from the current day T (for example, T-10)

Default value is T, date and time today.

See Using the Home Menu for more information about PIT mode.

Note: This property is only used if the UsePIT property is set to 1 - Yes.

ProcessVarXml

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.

RecordSpan

Integer

No

Return/sets the span of each record displayed in the FMS History Graph. Possible values for this property are as follows.

  • 60 – Hourly
  • 1440 – Daily
  • 9999 – Native

Default value is 9999 - Native

SessionBeginDate

String

No

Returns/sets the Session starting date for the time window displayed in the control.  This string can either be in the form of an Absolute date, for example, 1/31/2019, or a Relative date, for example, T (today), T-14 (14 days prior to today), or T+1 (one day following today).

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

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.

SessionEndDate

String

No

Returns/sets the Session ending date for the time window displayed in the control. This string can either be in the form of an Absolute date, for example, 1/31/2019, or a Relative date, for example, T (today), T-14 (14 days prior to today), or T+1 (one day following today).

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

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.

SessionNodeTag

String

No

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: This property is only used if the UseSessionOptions property is set to 1 - Yes.

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.

ShowChooserPane

Boolean

No

Returns/sets whether or not the Chooser pane will be displayed in the control.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

ShowLegend

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.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

ShowOptionsPane

Boolean

No

Returns/sets whether or not the Options pane will be displayed in the control.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

UnitSet

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

UseHeightOverride

Boolean

No

Returns/sets whether or not the HeightOverride property will be used. Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 0 - No

UsePIT

Boolean

No

Returns/sets whether or not the PITDateTime property will be used. Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 0 - No

UseSessionNode

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.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

Note: The Use Session options property default value is 1 - Yes/True for Data controls (Alarm, Configuration, History Graph, History Grid, Raw Data). The property default value is 0 - No/False for Summary controls (Dashboard, Exceptions) and Admin controls (PPA, Balance, Jobs; not applicable to Close Period).

UseSessionOptions

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.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

Note: The Use Session options property default value is 1 - Yes/True for Data controls (Alarm, Configuration, History Graph, History Grid, Raw Data). The property default value is 0 - No/False for Summary controls (Dashboard, Exceptions) and Admin controls (PPA, Balance, Jobs; not applicable to Close Period).

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.