Profile Class

 

Profile Class consists of the following properties:

Property

Description

Data Type

Default

DisplayInLegend Determines if the profile label is to be displayed in the Legend. Boolean TRUE

Label

Determines the label that will be displayed for the Profile in the Legend.

String - max length of 100

Profile#

LineColor

Determines the color the line will be displayed in.

Long integer.  The RGB function may also be used to set the color.

&H0 (Black)

LineOption

Determines whether or not a line, between the Profile datapoints, is to be displayed.

Enumerated type consisting of the following options:

  • loNone (=0)
  • loCustom (=1)

loCustom

LineStyle

Determines the style the line will be displayed in.

Enumerated type consisting of the following options:

  • soSolid (=1)
  • soDash (=2)
  • soDot (=3)
  • soDashDot (=4)
  • soDashDotDot (=5)

soSolid

LineWidth

Determines the width the line will be displayed with.

 

NOTE: If the width is greater than 1, then the line style applied will always be solid.

Enumerated type consisting of the following options:

  • woOnePoint (=1)
  • woTwoPoint (=2)
  • woThreePoint (=3)
  • woFourPoint (=4)
  • woFivePoint (=5)

woOnePoint

MarkerBordercolor

Determines the color the marker will be outlined in.

Long integer.  The RGB function may also be used to set the color.

&H0 (Black)

MarkerFillcolor

Determines the color the marker will be filled in with.

Long integer.  The RGB function may also be used to set the color.

&H0 (Black)

MarkerOption

Determines whether or not a marker, for the individual Profile datapoints, is to be displayed.

Enumerated type consisting of the following options:

  • loNone (=0)
  • loCustom (=1)

loCustom

MarkerSampleStep The Step value in the loop that draws the profile's data markers. If MarkerSampleStep is 2, every other data point marker is drawn.  Increasing the MarkerSampleStep property decreases the refresh time by not having to draw every marker. Long integer.  Value must be >= 1. 1

MarkerSize

Determines the display size of the marker.

Integer.  Valid range is 1..50.

2

MarkerStyle

Determines the style the marker will be displayed in.

Enumerated type consisting of the following options:

  • msCircle (=1)
  • msSquare (=2)
  • msDiamond (=3)
  • msTriangle (=4)

msCircle

NumSamples Determines the number of samples for the Profile. Long integer.  Valid range is 1..1,000,000.

100

SampleStep The Step value in the loop that draws the profile. If SampleStep is 2, every other data point is plotted.  Increasing the SampleStep property decreases the refresh time by not having to plot every value.  See SampleStep Feature. Long integer.  Value must be >= 1. 1
StairMode Determines whether the profile's line segments will be displayed as steps. Boolean FALSE

Visible

Determines whether or not the Profile will be visible in the plot.

Boolean

TRUE

XScale

Determines which X-axis scale the Profile will be plotted against.

Integer

1

YScale

Determines which Y-axis scale the Profile will be plotted against.

Integer

1