CxTrend Properties

The CxTrend object contains the following properties:

Browse by letter:     [A]     [B]     [C]     [D]     [E]     [F]     [G]     [I]     [L]     [M]     [N]     [O]     [P]     [R]     [S]     [T]     [U]     [V]     [X]     [Y]     [Z]

Property

Type

Read Only Description

AbsoluteDateRange

Boolean

No

Specifies whether or not the object uses absolute or relative date properties. Absolute date properties are EarliestDate and LatestDate. Options are 0 — No and 1 — Yes. Default is 0 — No.

AllowUnitsChange

Boolean

No

Enables unit changes to be displayed in Run mode. Unit types affected are primary and alternate. Options are 0 — No and 1 — Yes. The default is 1 — Yes. If 0 — No is specified, the Use Alternate Units option is disabled in Run mode. Script subtype is Boolean.

AlternateUnits

Boolean

No

Specifies that the object display values in alternate units instead of primary units. Alternate units must be defined in the point configuration record for the relevant point. Otherwise, alternate units cannot be displayed by the tool. Property sheet options are 0 — No and 1 — Yes. Default is 0 — No. Script subtype is Boolean.

AlternateUnitsOverride

String

No

Specifies the name of alternate units used when overriding alternate units derived from the point configuration record. They are defined on a per-series basis. This property is series indexed.

AnnotationColor

Long

No

Specifies the color of text annotations drawn by the Display Information > Time Slice Values and Display Information > Series Tags modes. The date of the time slice remains black and cannot be changed. Default is black (RGB 0.0.0).

AnnotationColorFromSeries

Boolean

No

Enables the color of text annotations in Display Information options to be derived from their corresponding series color. Options are 0 — No and 1 — Yes. Default is 0 — No. When set to 0 — No, the text color for all annotations is specified by AnnotationColor. When set to 1 — Yes, AnnotationColor is ignored and each text annotation is drawn in the color of its corresponding series.

Appearance

Integer

No

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.

AutoExtendEnabled

Boolean

No

Enables the object to automatically retrieve and display new data according to a specified time interval. This appears to extend a trend to the right as it refreshes. Options are 0 — No and 1 — Yes. Default is 0 — No.

AutoExtendRateSec

Double

No

Specifies the time interval in seconds by which the object refreshes. Default is 1.

AutoScale

Boolean

No

Enables a y-axis to automatically scale according to the value of the data it displays. Available for backwards compatibility only. Use AutoScaleMax and AutoScaleMin instead.

Script subtype is Boolean. (True means that both AutoScaleMax and AutoScaleMin are true.)

AutoScaleMax

Boolean

No

Specifies whether or not the y-axis upper limit automatically scales relative to the data it displays. When activated, overrides MaxY. Enabled by default, which means that scaling occurs automatically.

This property is axis indexed.

AutoScaleMin

Boolean

No

Specifies whether or not the y-axis lower limit automatically scales relative to the data it displays. If activated, overrides MinY. Enabled by default, which means that scaling occurs automatically.

This property is axis indexed.

AxisCount

Integer

Yes

Specifies the total number of configured y-axes in the object. In other words, specifies the upper bound for the XML axis index. This property is read only.

AxisID

Integer

Yes

Specifies the user-defined number (0 — 15) assigned to a y-axis. Once the axis ID number is assigned to a y-axis, the number cannot be changed. If you want to change an axis ID number, you must delete the axis and create a new one from the available axis ID numbers. This property is axis indexed. This property is read only.

AxisNumber

Integer

No

Specifies the y-axis number with which a specific series is associated. Options are integers that correspond with configured y-axes. This property is series indexed.

BackColor

Long

No

BackColor specifies a background color for the object or grid. Note that if an object’s [AlarmElement] property is set to Background Color and a primary point is assigned to the object, the background color will change in Run mode to reflect the point status.

The default is Automatic, which is the background color of TheView for most objects.

Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'

BorderStyle

Integ

No

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.

Commas

Boolean

No

Specifies whether or not a large value on the y-axis uses commas as its numeric divider. Options are 0 — No and 1 — Yes. Default is 1 — Yes.

CrosshairFontSize

Integer

No

Specifies the font size for the Display Information > Value at Cross Hairs option in Run mode. Options are 0 (large), 1 (medium), and 2 (small). Default is 2 (small).

CurrentTimeSource

Integer

No

Specifies the source of the current date and time used to define the limits of the view window.

Options are as follows:

  • 0 — Client Time: Specifies that the view window is created relative to the client current time. Best practice strongly recommends ensuring that all relevant servers and clients are synchronized to the same time.
  • 1 — Server Time: Specifies that the view window is created relative to the server (i.e., ARS) current time. If this setting is used but the server time is unavailable, the client time is used for as long as the server time is unavailable. Best practice strongly recommends ensuring that all relevant servers and clients are synchronized to the same time.
  • 2 — Series Time: Specifies that the view window is created relative to the most recent time supplied by a series, server, or client. This means that if any series time on a trend is the most recent time of the three possible time sources, the series defines the latest extent of the view window and appears to be in the future. May be used as a way of correcting for time drift or other similar anomalous situations where series data appears to be "ahead" of the local current time.

Default is 0 — Client Time.

Script subtype is integer.

CustomLabel1

String

No

Specifies the label name of the toolbar's Button 1. ToolbarLocation must be enabled for the toolbar and its buttons to be displayed. Default is 8.

CustomLabel2

String

No

Specifies the label name of the toolbar's Button 2. ToolbarLocation must be enabled for the toolbar and its buttons to be displayed. Default is 24.

CustomLabel3

String

No

Specifies the label name of the toolbar's Button 3. ToolbarLocation must be enabled for the toolbar and its buttons to be displayed. Default is 3D.

CustomScroll1

Integer

No

Specifies the time increment by which a trend's view window increases if Button 1 is clicked. The increment is relative to the unit type specified for the object's toolbar. Default is 1.

CustomScroll2

Integer

No

Specifies the time increment by which a trend's view window increases if Button 2 is clicked. The increment is relative to the unit type specified for the object's toolbar. Default is 8.

CustomScroll3

Integer

No

Specifies the time increment by which a trend's view window increases if Button 3 is clicked. The increment is relative to the unit type specified for the object's toolbar. Default is 24.

CustomSize1

Integer

No

Specifies the size of a trend's view window in units of time if Button 1 is clicked. The size is relative to the unit type specified for the object's toolbar. Default is 8.

CustomSize2

Integer

No

Specifies the size of a trend's view window in units of time if Button 2 is clicked. The size is relative to the unit type specified for the object's toolbar. Default is 24.

CustomSize3

Integer

No

Specifies the size of a trend's view window in units of time if Button 3 is clicked. The size is relative to the unit type specified for the object's toolbar. Default is 72.

CustomUnits

Integer

No

Specifies a time unit type that corresponds to the values specified for the Custom View Buttons fields View Size and Scroll Size. View Size and Scroll Size use the various CustomSize and CustomScroll properties. Options are 0 — Seconds, 1 — Minutes, 2 — Hours, 3 — Days, 4 — Weeks, and 5 — Years. Default is 2 — Hours.

DataShadows

Integer

No

Specifies the display of a shadow or 3-D effect with certain graph items, like series lines. Options are 0 — None, 1 — 2D, and 2 — 3D. Default is 0 — None.

DataThinning

Integer

No

Enables a graph to automatically filter out excessive data points. This can improve performance if you are displaying a large amount of data. Typically, the effect of data thinning is not noticeable to a user. However, if MarkDataPoints is enabled, the effect of data thinning might be noticeable. All data points still display upon zoom. Data thinning is currently incompatible with square wave lines.

Options are as follows:

  • 0 — Off: Always displays all data points.
  • 1 — Basic: Enables quick data thinning, for best performance.
  • 2 — Advanced: Enables slow data thinning, which is more thorough than Basic, but performance is not as good.

Default is 1 — Basic.

DefaultFacilityId

String

No

Specifies a default facility ID for the object. Default is blank.

DefaultSiteService

String

No

Specifies the default current value service for the object. Default is blank.

Display Information

Integer

No

Enables you to select one of several special display modes. Most of the following modes affect what happens when a data point on a trend is clicked. Options are 0 — None, 1 — Crosshairs, 2 — Tag, 3 — Timeslice, 4 — Timeslice Table, and 5 — Notes. Default is 0 — None.

EarliestDate

Variant

No

Specifies the earliest (i.e., least recent) date and time for a trend for an absolute date and time view window. Format is MM/DD/YYYY hh:mm:ss AM/PM. Default is the system date and time at which the tool was first added to a screen.

If AbsoluteDateRange is not enabled, earliest date and time is calculated based on a combination of current system date and time, EarliestDateCount, and EarliestDateUnits.

EarliestDateCount

Integer

No

If the view window date range is relative (that is, not absolute), specifies the number of time units before the current system date and time from which to display trend data. Default is 8.

EarliestDateUnits

Integer

No

If the view window date range is relative (that is, not absolute), specifies the time unit type for the earliest date and time from which to display trend data. Options are 0 — Seconds, 1 — Minutes, 2 — Hours, 3 — Days, 4 — Weeks, and 5 — Years. Default is 2 — Hours.

EarliestDisplayedDate

Variant

Yes

Returns the earliest date and time displayed on a trend.

EnhancedGraphics

Boolean

No

Enables enhanced trend graphics, including anti-aliased lines and softer colors. Using this option might decrease the object's performance. Options are 0 — No and 1 — Yes. Default is 1 — Yes.

ExtendLastValue

Boolean

No

Places a virtual data point at the current time that reflects the most recently retrieved value. This has the appearance of extending the most recently retrieved (i.e., last) value up to the current time. Can be used in combination with AutoExtendEnabled. Options are 0 — No and 1 — Yes. Default is 1 — Yes.

FacilityId

String

No

Currently disabled. This property is series indexed.

FillColor

Long

No

Specifies the color to be used for a trend fill. Used in conjunction with FillEnabled. Default is green (RGB 134.223.53).

FillEnabled

Boolean

No

Enables a solid-color fill area to be drawn between two series on the same y-axis. Options are 0 — No and 1 — Yes. Default is 0 — No.

FillSeries1

Integer

No

Specifies one of the two series used to delimit a trend fill on the same y-axis. When enabled by FillEnabled, the area between this series and that specified by FillSeries2 is a solid color.

Option is a non-negative integer that correlates to the delimiting series's configured series index number. The configured series index number is the number given to a series in the vertical order it appears in the series hierarchy of a Trend Tool. The topmost series is 0, the next series down is 1, and so on. Default is -1. This property is series indexed.

FillSeries2

Integer

No

Specifies one of the two series used to delimit a trend fill on the same y-axis. When enabled by FillEnabled, the area between this series and that specified by FillSeries1 is a solid color.

Option is a non-negative integer that correlates to the delimiting series's configured series index number. The configured series index number is the number given to a series in the vertical order it appears in the series hierarchy of a Trend Tool. The topmost series is 0, the next series down is 1, and so on. Default is -1. This property is series indexed.

FixedFonts

Boolean

No

Prevents fonts from increasing in size as the object is resized. Options are 0 — No and 1 — Yes. Default is 1 — Yes.

FixedLineWidth

Boolean

No

If enabled, prevents series line type widths from increasing in size as the object is resized. If disabled, only a subset of available series line types resize as the object resizes. The subset is as follows:

  • Medium Solid
  • Thick Solid
  • Medium Thin Solid
  • Medium Thick Solid
  • Extra Thick Solid

This property maintains legacy behavior for existing screens. Options are 0 — No and 1 — Yes. Default is 1 — Yes.

FontSize

Integer

No

Specifies the size of textual items on the object relative to the size of the object. Options are 0 — Large, 1 — Medium, and 2 — Small. Default is 1 — Medium.

ForeColor

Long

No

Specifies the foreground color of textual items outside the object's graph. Default is black (RGB 0.0.0).

GraphBackColor

Long

No

Specifies the background color of the object's graph. Default is white (RGB 245.245.245).

GraphBorderStyle

Integer

No

Specifies the use of a border and border style for an object's graph.

Options are as follows:

  • 0 — None
  • 1 — Thin Line
  • 2 — Thick Line
  • 3 — Shadow
  • 4 — 3D Inset

Default is 1 — Thin Line.

GraphForeColor

Long

No

Specifies the foreground color of the object's graph. Default is dark gray (RGB 128.128.128).

GraphShadowColor

Long

No

Specifies the color of the object's graph shadow. Default is dark gray (RGB 128.128.128). GraphBorderStyle must be set to Shadow in order for GraphShadowColor to take effect.

GridBands

Boolean

No

Displays the graph with a banded-background view for improved visibility. The GraphBackColor property changes the band colors. Options are 0 — No and 1 — Yes. Default is 1 — Yes.

GridInFront

Boolean

No

Specifies whether or not to have grid lines appear in front of series lines or behind series lines. Options are 0 — No and 1 — Yes. Default is 0 — No.

GridLines

Integer

No

Specifies whether or not grid lines are displayed on the object's graph. Options are 0 — Both, 1 — Y Axis, 2 — X Axis, and 3 — None. Default is 0 — Both.

GridStyle

Integer

No

Specifies the style of grid lines displayed on the object's graph. Options are 0 — Thin Lines, 1 — Thick Lines, 2 — Dotted Lines, and 3 — Dashed Lines. Default is 2 — Dotted Lines.

IsAxisEmpty

Boolean

Yes

Returns a Boolean value to confirm whether or not a y-axis has no series assigned to it. True indicates that a y-axis has no series assigned to it. If true, the y-axis is not displayed in Run mode. This property is axis indexed. This property is read only.

KeyboardShortcutsEnabled

Boolean

No

Specifies whether or not keyboard shortcuts are enabled. Options are 0 — No and 1 — Yes. The default is 1 — Yes.

LabelFont

String

No

Specifies the trend label font type. It does not apply to title and sub-title font. Default is Arial.

LabelFontBold

Boolean

No

Specifies whether or not label font is bold. Options are 0 — No and 1 — Yes. Default is 0 — No.

LabelFontItalic

Boolean

No

Specifies whether or not label font is italic. Options are 0 — No and 1 — Yes. Default is 0 — No.

LabelFontUnderline

Boolean

No

Specifies whether or not label font is underlined. Options are 0 — No and 1 — Yes. Default is 0 — No.

LatestDate

Variant

No

Specifies the latest (i.e., most recent) date and time for a trend for an absolute date and time view window. Format is MM/DD/YYYY hh:mm:ss AM/PM. Default is the system date and time at which the tool was first added to a screen.

If AbsoluteDateRange is not enabled, earliest date and time is calculated based on a combination of current system date and time, EarliestDateCount, and EarliestDateUnits.

LatestDisplayedDate

Variant

Yes

Returns the latest date and time displayed on a trend.

Legend

String

Yes

Returns and displays the legend string appropriate to that defined by token substitution.

LegendFormat

Long

No

Specifies various number-based legend formatting options. Exposed for legacy support. Default is 0.

LegendFormatStr

String

No

Specifies the tokenized legend format. Default is %longdescription%.

LegendLocation

Integer

No

Specifies the location of the legend relative to the graph. Options are 0 — None, 1 — Top, 2 — Bottom, 3 — Left, and 4 — Right. Default is 2 — Bottom.

LegendOutline

Boolean

No

Specifies whether or not to have a legend item's series icon outlined. Options are 0 — No and 1 — Yes. Default is 0 — No.

LegendOverride

String

No

Specifies a legend format that overrides the one specified by LegendFormatStr on a per-series basis. You can specify a tokenized legend format or user-defined text. This property is series indexed.

LineType

Integer

No

Specifies the line appearance and/or size for a single series line.

Options are as follows:

  • 0 — Thin Solid
  • 1— Dashed
  • 2 — Dotted
  • 3 — Dash Dot
  • 4 — Dash Dot Dot
  • 5 — Medium Solid
  • 6 — Thick Solid
  • 7 — Medium Thin Solid
  • 8 — Medium Thick Solid
  • 9 — Extra Thick Solid
  • 10 — Extra Thin Solid
  • 11 — Extra-Extra Thin Solid

Default is 0 — Thin Solid. This property is series indexed.

MarkDataPoints

Boolean

No

Specifies whether or not to have solid black dots drawn at data points. This property is not related to PointType. Options are 0 — No and 1 — Yes. Default is 0 — No.

MaximumPointSize

Integer

No

Specifies the setting of an upper limit for the size of data points. This ensures that points do not scale to an unreasonably large size. Only works if MarkDataPoints is set to 1 — Yes.

Options are as follows:

  • 0 — None: Places no upper boundary on the size of a data point. Data points continue to increase in size as a trend tool is expanded.
  • 1 — Small: Ensures that data points scale within a range appropriate to a small point. Scales to a maximum size of 2 pixels.
  • 2 — Medium: Ensures that data points scale within a range appropriate to a medium point. Scales to a maximum size of 6 pixels.
  • 3 — Large: Ensures that data points scale within a range appropriate to a large point. Scales to a maximum size of 10 pixels.

Default is 3 — Large.

MaxY

Double

No

Specifies the user-defined upper limit a y-axis displays. The y-axis scale adjusts accordingly. Overridden if AutoScaleMax is enabled. This property is axis indexed.

MinY

Double

No

Specifies the user-defined lower limit a y-axis displays. The y-axis scale adjusts accordingly. Overridden if AutoScaleMin is enabled. This property is axis indexed.

MonoAnnotationColor

Long

No

Specifies the grayscale color of text annotations drawn by the Display Information > Time Slice Values and Display Information > Series Tags modes. Useful with black and white or grayscale printers. The date of the time slice remains black and cannot be changed. Default is black (RGB 0.0.0).

MonoBackColor

Long

No

Specifies the grayscale color of the trend's background. Useful with black and white or grayscale printers. Default is white (RGB 255.255.255).

MonoForeColor

Long

No

Specifies the grayscale color of the trend's foreground. Useful with black and white or grayscale printers. Default is black (RGB 0.0.0).

MonoGraphBackColor

Long

No

Specifies the grayscale color of the graph's background. Useful with black and white or grayscale printers. Default is white (RGB 255.255.255).

MonoGraphForeColor

Long

No

Specifies the grayscale color of the graph's foreground. Useful with black and white or grayscale printers. Default is gray (RGB 128.128.128).

MonoGraphShadowColor

Long

No

Specifies the grayscale color of the graph's shadow. Useful with black and white or grayscale printers. Default is gray (RGB 128.128.128).

NoteFilter

String

No

Specifies a filter by which to sort and display notes on trend. On the Property Sheet, you can manually enter a filter. You can also use the Set Note Rules dialog box to do so. Default is blank.

NumericPrecision

Integer

No

Specifies the number of decimal places to display for the Display Information > Value at Cross Hairs option in Run mode. Default is 3.

OnRightAxis

Boolean

No

Specifies the position of a y-axis label relative to the graph. If set to false, position is to the left of a y-axis. This property is axis indexed.

OverlayYAxis

Boolean

No

Specifies whether or not a y-axis belongs to the same axis group as the y-axis previous to it. This property is axis indexed.

OverrideAlternateUnits

Boolean

No

Enables a user to override the alternate units derived from the point configuration record on a per-series basis. This property is series indexed.

OverridePrimaryUnits

Boolean

No

Enables a user to override the primary units derived from the point configuration record on a per-series basis. This property is series indexed.

PlotSquareWave

Boolean

No

Specifies whether or not a series displays in a square wave. MarkDataPoints must be enabled for PlotSquareWave to take effect. This property is series indexed.

PlotStyle

Integer

No

Specifies the appearance of series on a per-y-axis basis. Default is 0 — Line. This property is axis indexed.

Options are as follows:

  • 0 — Line
  • 1 — Bar
  • 2 — Points
  • 3 — Area
  • 4 — Points + Best Fit Curve
  • 5 — Points + Best Fit Line
  • 6 — Points + Line
  • 7 — Points + Spline
  • 8 — Spline

Using points plot styles (for instance, Points + Line) in conjunction with PlotSquareWave or ExtendLastValue might result in inauthentic points for the purposes of enabling those options. Conversely, using points plot styles in conjunction with DataThinning might result in fewer displayed data points.

PointId

String

No

Specifies the point ID of the tag for which a series is to display information. This property is series indexed.

PointIdLong

String

No

Specifies the long point ID of the tag for which a series is to display information. This property is series indexed.

PointType

Integer

No

Specifies the shape of a data point icon for a series. The series's assigned y-axis must be set to a PlotStyle that includes points (for instance, Points, Points + Best Fit Curve, Points + Best Fit Line, Points + Line, or Points + Spline). This property is series indexed.

Options are as follows:

  • 0 — Plus
  • 1 — Cross
  • 2 — Circle
  • 3 — Solid Circle
  • 4 — Square
  • 5 — Solid Square
  • 6 — Diamond
  • 7 — Solid Diamond
  • 8 — Upward Triangle
  • 9 — Solid Up Triangle
  • 10 — Downward Triangle
  • 11 — Solid Down Triangle

Default is 3 — Solid Circle.

PrimaryUnitsOverride

String

No

Specifies the name of primary units used when overriding primary units derived from the point configuration record. They are defined on a per-series basis. This property is series indexed. Default is 3 — Solid Circle.

PropertyXml

String

No

Lists a trend's properties in an XML format. Useful for copying XML records in or out of the tool.

RollupPeriod

Integer

No

Specifies the rollup period of the value entry. Rollup period refers to the quantity of units in a period. For example, to rollup 30 days, the RollupPeriod is 30 and the RollupUnit is "days." This property is series indexed. See History Rollups for more information.

RollupType

Integer

No

Specifies the type by which to roll up data for a selected point. This property is series indexed.

Options are as follows:

  • 0 — None
  • 1 — Calculated Weighted Average
  • 2 — Calculated Mean
  • 3 — Calculated Minimum
  • 4 — Calculated Maximum
  • 5 — Calculated Delta
  • 6 — Calculated Last
  • 7 — Thin Median
  • 8 — Thin Minimum/Maximum
  • 9 — Thin Last

Default is 0 — None.

Using RollupType might be preferable to using DataThinning because rollup calculations performed by the VHS can provide improved performance and reduced network traffic relative to DataThinning.

See History Rollups for more information.

RollupUnits

Integer

No

Specifies the time units by which a rollup takes place. This property is series indexed.

Options are as follows:

  • 0 — None
  • 1 — Minutes
  • 2 — Hours
  • 3 — Days
  • 4 — Seconds

Default is 0 — None.

See History Rollups for more information.

ScrollCount

Integer

No

Specifies the number of time units by which to scroll forwards and backwards along a graph.

ScrollUnits

Integer

No

Specifies the time unit type by which to scroll forwards and backwards along a graph. Default is 2 — Hours.

Options are as follows:

  • 0 — Seconds
  • 1 — Minutes
  • 2 — Hours
  • 3 — Days
  • 4 — Weeks
  • 5 — Years

SeriesColor

Long

No

Specifies a color for a single series. This property is series indexed.

SeriesCount

Integer

Yes

Specifies the total number of configured series in a trend. In other words, specifies the upper bound for the XML series index.

SeriesData

String

No

Lists a trend's properties in an XML format. Useful for copying XML records in or out of the tool.

ShowUnreliable

Boolean

No

Enables unreliable values to be included in series. Options are 0 — No and 1 — Yes. Default is 0 — No.

SiteService

String

No

Specifies the site and service of the tag for which a series is to display information. The format of the value is Site.Service. This property is series indexed.

SubTitle

String

No

Specifies the subtitle of the object. The subtitle is displayed at the top of the object, but below the title. Default is blank.

SubTitleDateRange

Boolean

No

Enables the display of the date range specified for the graph. If enabled, the date range displays below the title and beside the subtitle (if a subtitle is specified). Options are 0 — No and 1 — Yes. Default is 1 — Yes.

SubTitleFont

String

No

Specifies the object subtitle font type. It does not apply to title and label font. Default is Arial.

SubTitleFontBold

Boolean

No

Specifies whether or not subtitle font is bold. Options are 0 — No and 1 — Yes. Default is 0 — No.

SubTitleFontItalic

Boolean

No

Specifies whether or not subtitle font is italic. Options are 0 — No and 1 — Yes. Default is 0 — No.

SubTitleFontUnderline

Boolean

No

Specifies whether or not subtitle font is underlined. Options are 0 — No and 1 — Yes. Default is 0 — No.

Title

String

No

Specifies the title of the trend. The title is displayed at the top of the trend. Default is blank.

TitleFont

String

No

Specifies the trend title font type. It does not apply to subtitle and label font. Default is Arial.

TitleFontBold

Boolean

No

Specifies whether or not title font is bold. Options are 0 — No and 1 — Yes. Default is 0 — No.

TitleFontItalic

Boolean

No

Specifies whether or not title font is italic. Options are 0 — No and 1 — Yes. Default is 0 — No.

TitleFontUnderline

Boolean

No

Specifies whether or not title font is underlined. Options are 0 — No and 1 — Yes. Default is 0 — No.

ToolbarLocation

Integer

No

Specifies the location of the toolbar relative to the graph. Options are 0 — None, 1 — Top, and 2 — Bottom. Default is 0 — None.

TopofSubUnit

Integer

No

TopOfSubUnit specifies the interval by which a rollup takes place by an additional unit of magnitude smaller than that specified by RollupUnits. Subunit means whatever unit of time is the next smaller than that specified for RollupUnits. This property is series indexed.

TrendFileName

String

No

Specifies the file name for the object and is present for backwards compatibility. Default is blank.

Udc

String

No

Specifies the UDC of the tag for which a series is to display information. This property is series indexed.

UseAlarmColor

Boolean

No

Specifies the use of CygNet point state colors for a single series. Only takes effect if a trend is displaying one series.

Options are 0 — No and 1 — Yes. Default is 0 — No.

VhsOverride

String

No

Specifies the name of a VHS used to override a series's default VHS. Can only be used on a series-by-series basis. Default is blank. This property is series indexed.

ViewSizeCount

Integer

No

If the view window date range is relative (that is, not absolute), specifies the size (in number of time units) of the view window. Default is 8.

ViewSizeUnits

Integer

No

If the view window date range is relative (that is, not absolute), specifies the time unit type for the view window. Options are 0 — Seconds, 1 — Minutes, 2 — Hours, 3 — Days, 4 — Weeks, and 5 — Years. Default is 2 — Hours.

ViewStyle

Integer

No

Specifies whether or not the object displays in color or grayscale. Options are 0 — Color, 1 — Monochrome, and 2 — Monochrome + Symbols. Default is 0 — Color.

XAxisLabel

String

No

Specifies the x-axis label for the object. Default is blank.

YAxisLabel

String

No

Specifies a user-defined y-axis label. It is specified on an axis-by-axis basis. Default is blank. This property is axis indexed.

YAxisLabelColorFromSeries

Boolean

No

Specifies whether or not the color of the y-axis label and the y-axis scale are determined by SeriesColor. Alternatively, you can specify the y-axis color using ForeColor. YAxisLabelColorFromSeries is overridden by UseAlarmColor, if UseAlarmColor is enabled. Options are 0 — No and 1 — Yes. Default is 0 — No. This property is axis indexed.

YAxisLabelFromLegend

Boolean

No

Specifies whether or not a y-axis label derives from its respective series legend. If not, can be user defined or blank. Options are 0 — No and 1 — Yes. Default is 0 — No.

YAxisType

Long

No

Specifies the scale type of a y-axis.

Options are as follows:

  • 0 — Automatic: If the data range is larger than or equal to 10e3 and all values are greater than zero, then a log scale is used. Otherwise, a linear scale is used.
  • 1 — Linear: A linear scale is used.
  • 2 — Logarithmic: A logarithmic scale is used if all values are greater than zero. Otherwise, a linear scale is used.

Default is 1 — Linear.

ZoomOverview

Boolean

No

Specifies whether or not to display a zoom overview window below the graph whenever the graph is in zoom mode. This property performs optimally when enabled in conjunction with EnhancedGraphics. Options are 0 — No and 1 — Yes. Default is 1 — Yes.

Back to top