Profile class consists of the following properties:
| Property | Description | Data Type | Default |
|---|---|---|---|
| BarBorderColor | Determines the color the bar border is displayed in.
Note: Bar Charting is not available in the Lite version. |
Color | Color.Black |
| BarBorderWidth | Determines the width the bar border is displayed with.
Note: Bar Charting is not available in the Lite version. |
Enumerated type consisting of the following options:
|
woOnePoint |
| BarFillColor | Determines the color the bar is filled with.
Note: Bar Charting is not available in the Lite version. |
Color | Color.Black |
| BarHorizontal | Determines if a bar is displayed horizontally (True)
or vertically (False).
Note: Bar Charting is not available in the Lite version. |
Boolean | False |
| BarReference | Determines the reference line the bar is drawn
against.
Note: Bar Charting is not available in the Lite version. |
Double | 0 |
| BarWidth | Determines the width of each bar.
Note: Bar Charting is not available in the Lite version. |
Double | 1 |
| ChartFeatureType | Determines which charting feature to apply for the
profile. Currently, only Bar charting is supported.
See Interpolation for the numerous options for visually displaying profile data. Note: Bar Charting is not available in the Lite version. |
Enumerated type consisting of the following options:
|
cfNone |
| DisplayInLegend | Determines if the profile label is to be displayed in the Legend. | Boolean | True |
| FillColor | Determines the color the profile fill is displayed
with.
Note: Profile Fill is not available in the Lite version. |
Color | Color.LightYellow |
| FillEnabled | Determines if the Profile Fill feature is enabled for
this profile. If TRUE, the profile line to the FillReference line is
shaded in with the specified FillColor.
Note: Profile Fill is not available in the Lite version. |
Boolean | False |
| FillHorizontal | Determines the direction of the profile fill.
Note: Profile Fill is not available in the Lite version. |
Boolean | False |
| FillReference | Determines the reference line the profile fill will be
drawn against.
Note: Profile Fill is not available in the Lite version. |
Double | 0 |
| Label | Determines the label that is displayed for the Profile in the Legend. Label cannot be empty. | String - max length of 100 | "Profile#" |
| LineColor | Determines the color the profile line is displayed in. | Color | Color.Black |
| LineOption | Determines whether or not a line, between the Profile datapoints, is to be displayed. | Enumerated type consisting of the following options:
|
loCustom |
| LineStyle | Determines the style the profile line is displayed with. | Enumerated type consisting of the following options:
|
soSolid |
| LineWidth | Determines the width the profile line is displayed with. | Enumerated type consisting of the following options:
|
woOnePoint |
| MarkerBordercolor | Determines the color the marker is outlined in. | Color | Color.Black |
| MarkerFillcolor | Determines the color the marker is filled in with. | Color | Color.Black |
| MarkerOption | Determines whether or not a marker, for the individual Profile datapoints, is to be displayed. | Enumerated type consisting of the following options:
|
loCustom |
| MarkerSampleStep | The Step value in the loop that draws the profile's data markers. If MarkerSampleStep is 2 then every other data point marker is drawn. Increasing the MarkerSampleStep property decreases the refresh time by not having to draw every marker. | Integer. Valid range is 1..NumSamples. | 1 |
| MarkerSize | Determines the display size of the marker. | Integer. Valid range is 1..50. | 1 |
| MarkerStyle | Determines the style the marker is displayed with. | Enumerated type consisting of the following options:
|
msCircle |
| NumSamples | Determines the number of samples for the Profile. | Integer. Valid range is 1..1,000,000.
Note: For Lite versions, the valid range is 1..5,000. |
100 |
| SampleStep | The Step value in the loop that draws the profile. If SampleStep is 2 then every other data point is plotted. Increasing the SampleStep property decreases the refresh time by not having to plot every value. See Sample Step Feature. | Integer. Valid range is 1..NumSamples. | 1 |
| SplineTension | Determines how tightly the profile curve bends through its coordinates. A value of zero corresponds to infinite physical tension resulting in straight line segments connecting the profile's data points. A value of one corresponds to no physical tension resulting in a sequence of individual curves connecting the profile's data points. A minimum of 4 consecutive data points are required for the spline curve to be drawn. | Single. SplineTension should be greater than or equal to 0, and less than or equal to 1. | 0 |
| StairMode | Determines whether the profile's line segments will be displayed as steps. | Boolean | False |
| Visible | Determines whether or not the Profile is visible in the plot. | Boolean | True |
| X Scale | Determines which X-axis scale the Profile is plotted against. | Integer | 0 |
| Y Scale | Determines which Y-axis scale the Profile is plotted against. | Integer | 0 |