SetDisplayMask

Void  SetDisplayMask (long DisplayMask);

 

Available (from release):

 

stOCX (V2-0), stPro Automation (V2-01)

 

Parameters:

 

Name:

Description:

DisplayMask

 Bitmask indicating what should be displayed on the graph.

 

Remarks:

 

Call this function to customize what is displayed on the graph.

 

Note:  DisplayMask is a bitmask indicating the display state of its associated feature

Item information:

 

When the items region of the graph is displayed on these values indicate which bits of information will be displayed. If the items region is switched off then no item information will be displayed.

 

Numeric:

Hex:

Description:

1

0x1

Item Name

2

0x2

Display Name

4

0x4

Engineering Units

8

0x8

Data Location

16

0x10

Scan Frequency

32

0x20

Scale Minimum

64

0x40

Scale Maximum

128

0x80

Item Value

256

0x100

Timestamp for the item value

512

0x200

Pen Number

1024

0x400

Item Description

 

 

Graph regions.

 

These values control which regions of the graph are switched on:

 

Numeric:

Hex:

Description:

16384

0x4000

Predictions

65536

0x10000

Left Vertical Axis

131072

0x20000

Right Vertical Axis

262144

0x40000

Time Axis

524288

0x80000

Control region

1048576

0x100000

Item Information Area

2097152 (D)

0x200000

Display the Plot (defaulted to on if any other attribute is set)

4194304

0x400000

Horizontal grid lines

8388608

0x800000

Vertical grid lines

16777216

0x1000000

Enables the cursor

 

 

Example:

 

If the graph is to be configured to display the following information:

 

Dim DisplayMask As Int

DisplayMask = 0

DisplayMask = DisplayMask  + 65536

DisplayMask = DisplayMask  + 131072

DisplayMask = DisplayMask  + 262144

DisplayMask = DisplayMask  + 1048576

DisplayMask = DisplayMask  + 2

DisplayMask = DisplayMask  + 128

SetDisplayMask(DisplayMask)