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

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.

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

Default value is T-7.

See Selecting Date and Time for more information.

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.

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, of the type specified by the ChooserFilterType property, when retrieving Nodes for selection

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 type 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 – Node_Category2_Device
  • 3 – Node_Category2_Station
  • 8 – Node_Category2_Gas_Device
  • 9 – Node_Category2_Liquid_Device

Default value is 8 - Node_Category2_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 combo box.

ChooserSiteServiceVisible

Boolean

No

Returns/sets whether or not the Node chooser’s FMS 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.

DataMode

Integer

No

Returns/sets whether a Station Meter Node (a Gas Meter Node set to also function as a station) will display station or device level data in the control [supersedes the deprecated MeterStationView property]

Possible values for this property are as follows.

  • 1 – Device_Mode
  • 3 – Station_Mode

Default value is 3 - Station_Mode.

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

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.

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

Default value is T.

See Selecting Date and Time for more information.

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.

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

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.

MeterStationView

Integer

No
Note: This property deprecated in favor of DataMode

Returns/sets whether Station Meters will be displayed in the FMS History Graph as Stations or Devices

See DataMode for details.

PITDateTime

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.

  • Absolute Date/Time - for example: 1/31/2023 7:10:14 AM)
  • Relative Date/Time - for example: y-1 m-2 d=15 H=5 M=30 S=0)
  • Relative Day - 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.

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 - appears for Device data view only; not applicable to Station data view

Default value is 9999 - Native for Device data view, 60 - Hourly for Station data view.

SessionBeginDate

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.

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

See Selecting Date and Time for more information.

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

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.

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

See Selecting Date and Time for more information.

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

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

Returns/sets the Session Node tag, which specifies the active Node in the FMS History Graph 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.

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 to use the SessionNodeTag property [if set to 1 - Yes] or to present a Chooser page for Node selection [if set to 0 - No] to specify the active Node in the control

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes for this control.

Note: Default value varies by control type.

UseSessionOptions

Boolean

No

Returns/sets whether to use the SessionBeginDate and SessionEndDate properties [if set to 1 - Yes] in place of the BeginDate and EndDate properties [if set to 0 - No]

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes for this control.

Note: Default value varies by control type.

Back to top