CygNet Studio > Using CygNet Studio Tools and Controls > CygNet Dynagraph Control > Properties, Events, and Methods > Properties

Dynagraph Control – Properties

The following table lists and describes properties of the Dynagraph Control. Properties are accessed using the control's Property Sheet or script editor.

Note: For advanced details about scripting these properties, see CxDynagraph Properties.

Property Sheet Script Editor Description

AllowUserInteraction

AllowUserInteraction

Allow user interaction with the object. Options are 0 - No or 1 - Yes. Default is 1 - Yes. If set to 1 - Yes users to use the context menu and adjust graph settings, like POC and MAL. If set to 0 - No, the object is still shown but its context menu is disabled.

Appearance

Appearance

Appearance specifies whether the object boundary (graph, cell in the grid, view, etc.) will have a 3D effect or a flat appearance. Options are 0 - Flat or 1 - 3D. Default is 0 - Flat.

BorderStyle

BorderStyle

BorderStyle specifies the border style of the object boundary.

Most tools use one of these sets of options:

  • 0 - ibsNone, 1 - ibsRaised, or 2 - ibsLowered, and the default is 0 - ibsNone
  • 0 - None or 1 - Fixed Single, and the default is 0 - None

The Panel Switch Tool uses these options:

  • 0 - ibsLine, 1 - ibsRaised, 2 - ibsLowered, 3 - ibsTop, and 4 - ibsNone, and the default is 0 - ibsLine.

For the Box, Frame, and Text tools, the BorderStyle property specifies the style of the object’s foreground lines. The options are:

  • 0 - Normal, 1 - 3D, 2 - Sunken, 3 - Raised, and 4 - None
  • The default for the Box Tool is 0 - Normal. The default for the Frame Tool is 1 - 3D. The default for the Text Tool is 4 - None.

    If you use 2 - Sunken or 3 - Raised and the effect is not visible, change the object’s HiliteColor.

    If you use 0 - Normal, 2 - Sunken, or 3 - Raised, you can set the border width using the PenWidth property.

For TheFrame/TheView, the BorderStyle property specifies both the style of the object's border and whether the object can be resized by the user in Run mode. The default is 0 - Thin, which means the border is thin and the size is static. The other possible option is 1 - Resizing, which means the border is thicker and can be resized.

See also Appearance.

Script subtype is integer.

Bottom

N/A

Bottom specifies the distance in pixels from the top of the object to the bottom of the object. You can dynamically change this value in Edit mode if you use the mouse to enlarge or shrink the object.

CardRefreshFrequency

CardRefreshFrequency

The rate (in seconds) by which to automatically refresh the displayed card(s). Default value is 30.

CardTraceDuration

CardTraceDuration

The duration of the card trace in seconds. The default is 120.

CardTraceRate

CardTraceRate

The frequency with which to poll current cards i seconds. The default is 30.

CursorPointer

N/A

For TheView, CursorPointer selects the cursor icon that appears when you mouse over objects.

For objects, CursorPointer selects the cursor icon for the instance of the object. The object’s cursor pointer takes precedence over TheView’s cursor pointer.

The default is 0 - Default. For TheView, this is an arrow. For other objects, the icon configured for TheView is used. Other options are:

  • 1 - Arrow
  • 2 - IBeam
  • 3 - Cross
  • 4 - UpArrow
  • 5 - NoDrop
  • 6 - Help
  • 99 - HotSpot
  • 100 - Timer

Script subtype is long.

DeviceId

DeviceId

Gets or sets the current pump off control device for which to display cards.

Enable

N/A

Enable specifies whether the user is able to interact with the object. Options are 0 - No and 1 - Yes. The default is 1 - Yes. If set to 0 - No, the object is still visible but its context menu is disabled.

Other options:

  • Completely hide the object in run mode using the Visible property.
  • Display the object but hide its [DisplayItem] using the [DisplayElement] property.

FacilityId

FacilityId

The relevant facility. This facility is typically that of the dynagraph-enabled remote device from which you want to collect dynagraph data.

FlexHorizontal

N/A

FlexHorizontal specifies whether the object moves or resizes horizontally or is unchanged when TheFrame is resized. Options are:

  • 0 - None (no resizing occurs)
  • 1 - Shift (the object is shifted)
  • 2 - Expand (the object expands or shrinks the same number of pixels as TheFrame)
  • 3 - Proportional (the object expands or shrinks proportionally to TheFrame)

Default is 0 - None.

FlexVertical

N/A

FlexVertical specifies whether the object moves or resizes vertically when TheFrame is resized. Options are:

  • 0 - None (no resizing occurs)
  • 1 - Shift (the object is shifted)
  • 2 - Expand (the object expands or shrinks the same number of pixels as TheFrame)
  • 3 - Proportional (the object expands or shrinks proportionally to TheFrame)

Default is 0 - None.

Group

N/A

Group groups objects into a discrete sequence that can be navigated using the arrow keys.

Options are 0 - No and 1 - Yes. The default is 0 - No.

To use this property:

1. Add objects that use the Group property to a screen.

2. Position them as you like (typically in a spatial configuration that reflects the order in which they were added to the screen).

3. Decide where in the spatial configuration logical groups begin and end.

4. Mark the beginning of a group by setting the Group property to 1 - Yes for the first object in the group.

5. Set Group set to 0 - No for other objects in the group.

The group is made up of all objects that 1) are added sequentially after an object with a Group property set to 1 - Yes and 2) that use a Group property set to 0 - No. A group's arrow navigation sequence reflects the order in which its objects were added to a screen.

This property is not related to the Draw > Group option in the CygNet Studio menu bar. This property might not be suited for use with all tools that include the Group property.

Script subtype is long.

See also Tabstop.

HelpContextID

N/A

HelpContextID specifies the object’s help identifier for context-sensitive help. TheFrame’s WhatsThisHelp must be enabled.

Script subtype is long.

Layer

N/A

Layer identifies the layer on which the object resides. Script subtype is Boolean.

Left

N/A

Left specifies the distance (in pixels) from the left edge of TheView’s scroll region to the left edge of the object.

MarkPoints

MarkPoints

Gets or sets the true or false property indicating whether the graph will draw dots for the data points.

MaxCardsToDisplay

MaxCardsToDisplay

The maximum number of cards that can be displayed on a control. Option must be an integer from 5 to 50. If you exceed the user-defined maximum, existing card(s) are removed from the control to accommodate the new card(s).

(ObjectCode)

N/A

(ObjectCode) specifies a unique identifier of the object. You can enter up to 39 characters. Valid characters are A-Z, 0-9, and underscore (_). Spaces are not allowed. The default is the object name and the numeric instance. Script subtype is string.

(OCXProperties)

 

Displays the OCXProperty dialog box unique to the object.

OverlayCards

OverlayCards

Overlay cards on top of one another. This enables you to compare different rod pump cycles from the same card type at once. Otherwise, only one selected card can be viewed at a time. Click the desired card key entry on the right side of the screen to bring one card to the foreground over the other(s).

RefreshFrequency

RefreshFrequency

The rate (in seconds) by which to automatically refresh the displayed card(s).

Right

N/A

Right specifies the distance (in pixels) from the left edge of TheView’s scroll region to the right edge of the object.

ShowDetails

ShowDetails

Display a table of rod pump details on the left of the control.

ShowFluidFill

ShowFluidFill

Display a horizontal white line on a surface card that marks the fluid fill as well as the point at which fluid fill begins to occur. This option is not available for all remote device types.

ShowInitialCards

ShowInitialCards

Gets or sets the settings for which type of cards to display. This value is a bitmask so you can indicate multiple types of cards to show.

Bit values:

  • 1 (0x01) Current cards
  • 2 (0x02) Shutdown cards
  • 4 (0x04) Pumpup cards
  • 8 (0x08) Reference cards
  • 16 (0x10) Start cards.
  • 32 (0x20) Ideal cards.
  • 64 (0x40) Alarm cards.
  • 128 (0x80) Failure cards.

Example

20 (0x14) show start cards and pumpup cards

ShowNetStroke

ShowNetStroke

Show a vertical white line that marks a calculated net stroke on a downhole card. You can drag the line along the x-axis to change net stroke data. Moving the line does not affect field device configuration; it is for visual display purposes only. When you move the mouse over the line, a tooltip appears with the net stroke value at the given position.

SiteService

SiteService

[SiteService] identifies the CVS, Facility Service, or Group Service for the settings. The format for the value is Site.Service.

If this field is blank, the Site.Service specified for TheView is used. If Site.Service is defined for both TheView and the object, the value specified for the object is used.

Tabstop

N/A

Tabstop specifies whether the focus stops on the object when you use the Tab key to navigate between objects (in other words, enables the object as a tab stop). Options are 0 - No and 1 - Yes. Default is 1 - Yes.

Script subtype is long.

See also Group and Tab Order.

Note: To set the tab order, use the Objects option on the Layout menu.

Tag

N/A

Tag is an extra field for application-specific purposes. Does not specify a CygNet point. Default is blank. Script subtype is string.

Top

N/A

Top specifies the distance (in pixels) from the top of TheView’s scroll region to the Top of the object.

ViewReference

ViewReference

Gets or sets the settings for displaying surface or downhole cards. A value of 0 is for surface cards, 1 is for downhole cards, and 2 is both.

Visible

N/A

Visible secifies whether the object is visible in Run mode. Options are 0 - No or 1 - Yes. Default is 1 - Yes.

Note: Objects are always visible in Edit mode, regardless of how this property value is set.

You can also:

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.