Cicode Programming Reference > Cicode Function Categories > Trend Functions Introduction > TrnSetDisplayMode

TrnSetDisplayMode

Specifies how raw trend samples are displayed on the screen.

Syntax

TrnSetDisplayMode(AN, PenNumber, DisplayMode)

AN:

The animation number of the chosen trend.

PenNumber:

The pen number of the chosen trend. Specify:

0 - The current pen

1-8 - Pens 1 through 8

-1 - All pens

DisplayMode:

The Display Mode parameters allow you to enter a single integer to specify the display options for a trend (for a maximum of eight trends).

To calculate the integer you should enter, select the options you want to use from the list below, adding their associated numbers together. The resulting integer is the DisplayMode parameter for that trend.

Note: Options listed in each group are mutually exclusive. The default value for each Display Mode is 258 (0 + 2 + 256).

Invalid/Gated trend options:

0 - Convert invalid/gated trend samples to zero.

1 - Leave invalid/gated trend samples as they are.

Ordering trend sample options:

0 - Order returned trend samples from oldest to newest.

2 - Order returned trend samples from newest to oldest.

Condense method options:

0 - Set the condense method to use the mean of the samples.

4 - Set the condense method to use the minimum of the samples.

8 - Set the condense method to use the maximum of the samples.

12 - Set the condense method to use the newest of the samples.

Stretch method options:

0 - Set the stretch method to step.

128 - Set the stretch method to use a ratio.

256 - Set the stretch method to use raw samples.

Gap Fill Constant option:

n - the number of missed samples that the user wants to gap fill) x 4096.

Display as Periodic options:

0 - Display according to trend type.

1048576 - display as periodic regardless of trend type.

Since the Display as Periodic options are read-only, they cannot be set using TrnSetDisplayMode. They can be retrieved using TrnGetDisplayMode() and also used with the TrnExport group of functions.

Return Value

0 (zero) if successful, otherwise an error is returned.

Related Functions

TrnGetDisplayMode, TrnGetTable

See Also

Trend Functions