XY Chart NET 3 Control Reference
Profile Class
XY Chart NET 3 Control Reference > Classes > Profile Class

Profile Class consists of the following properties:

Property Description Data Type Default
BarBorderColor Determines the color the bar border is displayed in.
Bar Charting is not available in the Lite version.
Color Color.Black
BarBorderWidth Determines the width the bar border is displayed with.
Bar Charting is not available in the Lite version.
Enumerated type consisting of the following options:
  • woOnePoint (=1)
  • woTwoPoint (=2)
  • woThreePoint (=3)
  • woFourPoint (=4)
  • woFivePoint (=5)
 woOnePoint
BarFillColor Determines the color the bar is filled with.
Bar Charting is not available in the Lite version.
Color Color.Black
BarFillGradientEndColor Determines the gradient's end color for the bar fill.
Bar Charting is not available in the Lite version.
Color Color.White
BarFillGradientOption Determines whether or not gradients will be drawn for the bar fill.
Bar Charting is not available in the Lite version.
Enumerated type consisting of the following options:
  • goNone (=0)
  • goCustom (=1)
 goNone
BarFillGradientOrientation Determines the gradient's orientation for the bar fill.
Bar Charting is not available in the Lite version.
Enumerated type consisting of the following options:
  • ooHorizontal (=0)
  • ooVertical (=1)
  • ooForwardDiagonal (=2)
  • ooBackwardDiagonal (=3)
  • ooRectangular (=4)
  • ooCircular (=5)
 ooHorizontal
BarFillGradientStartColor Determines the gradient's start color for the bar fill.
Bar Charting is not available in the Lite version.
Color Color.Black
BarHorizontal Determines if a bar is displayed horizontally (True) or vertically (False).
Bar Charting is not available in the Lite version.
Boolean False
BarReference Determines the reference line the bar is drawn against.
Bar Charting is not available in the Lite version.
Double 0
BarWidth Determines the width of each bar.
Bar Charting is not available in the Lite version.
Double 1
BuySignal Determines the Buy signal to display. Enumerated type consisting of the following options:
  • soArrowDown (=0)
  • soArrowUp (=1)
  • soTriangleDown (=2)
  • soTriangleUp (=3)
  • soCircle (=4)
  • soDiamond (=5)
 soArrowUp
BuySignalBorderColor Determines the color the border of the Buy signal will be displayed with. Color Color.Green
BuySignalData Indicates at what x-value(s) the Buy signal(s) should be displayed. Double() Array is initially empty
BuySignalDisplay Determines placement of the Buy signal. Enumerated type consisting of the following options:
  • sdAbove(=0)
  • sdBelow(=1)
 sdBelow
BuySignalDisplayOffset Determines the number of pixels above/below the profile to display the Buy signal. Integer 3
BuySignalFillColor Determines the color the Buy signal will be filled with. Color Color.Green
BuySignalSize Determines the display size, in pixels, of the Buy signal. Integer 8
CandleBodyMargin Determines the offset margin, in pixels, for the candle. Only applicable if CandleBodyWidth=0.
Candle Charting is not available in the Lite version.
Integer 1
CandleBodyWidth Determines the width, in pixels, of the candle. A 0 width indicates that the candle width will automatically be adjusted to span the width of the day, less the CandleBodyMargin offset.
Candle Charting is not available in the Lite version.
Integer 5
CandleDownColor Determines the color the body of the candle will be displayed in when the day's close value is lower than the day's open value.
Candle Charting is not available in the Lite version.
Color Color.Red
CandleDownGradientEndColor Determines the gradient's end color for the candle in the down direction.
Candle Charting is not available in the Lite version.
Color Color.White
CandleDownGradientOption Determines whether or not gradients will be drawn for the candle in the down direction.
Candle Charting is not available in the Lite version.
Enumerated type consisting of the following options:
  • goNone (=0)
  • goCustom (=1)
 goNone
CandleDownGradientOrientation Determines the gradient's orientation for the candle in the down direction.
Candle Charting is not available in the Lite version.
Enumerated type consisting of the following options:
  • ooHorizontal (=0)
  • ooVertical (=1)
  • ooForwardDiagonal (=2)
  • ooBackwardDiagonal (=3)
  • ooRectangular (=4)
  • ooCircular (=5)
 ooHorizontal
CandleDownGradientStartColor Determines the gradient's start color for the candle in the down direction.
Candle Charting is not available in the Lite version.
Color Color.Red
CandleShadowDownColor Determines the color the shadow of the candle will be displayed in when the day's close value is lower than the day's open value.
Candle Charting is not available in the Lite version.
Color Color.Red
CandleShadowUpColor Determines the color the shadow of the candle will be displayed in when the day's close value is greater than the day's open value.
Candle Charting is not available in the Lite version.
Color Color.Green
CandleShadowWidth Determines the width, in pixels, of the shadow lines and the border around the candle body.
Candle Charting is not available in the Lite version.
Integer 1
CandleUpColor Determines the color the body of the candle will be displayed in when the day's close value is greater than the day's open value.
Candle Charting is not available in the Lite version.
Color Color.Green
CandleUpGradientEndColor Determines the gradient's end color for the candle in the up direction.
Candle Charting is not available in the Lite version.
Color Color.White
CandleUpGradientOption Determines whether or not gradients will be drawn for the candle in the up direction.
Candle Charting is not available in the Lite version.
Enumerated type consisting of the following options:
  • goNone (=0)
  • goCustom (=1)
 goNone
CandleUpGradientOrientation Determines the gradient's orientation for the candle in the up direction.
Candle Charting is not available in the Lite version.
Enumerated type consisting of the following options:
  • ooHorizontal (=0)
  • ooVertical (=1)
  • ooForwardDiagonal (=2)
  • ooBackwardDiagonal (=3)
  • ooRectangular (=4)
  • ooCircular (=5)
 ooHorizontal
CandleUpGradientStartColor Determines the gradient's start color for the candle in the up direction.
Candle Charting is not available in the Lite version.
Color Color.Green
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.                

Bar Charting is not available in the Lite version.
Enumerated type consisting of the following options:
  • cfNone (=0)
  • cfBar (=1)
 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.
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.
Profile Fill is not available in the Lite version.
Boolean False
FillGradientEndColor Determines the gradient's end color for the Profile Fill.
Profile Fill is not available in the Lite version.
Color Color.White
FillGradientOption Determines whether or not gradients will be drawn for the Profile Fill.
Profile Fill is not available in the Lite version.
Enumerated type consisting of the following options:
  • goNone (=0)
  • goCustom (=1)
 goNone
FillGradientOrientation Determines the gradient's orientation for the Profile Fill.
Profile Fill is not available in the Lite version.
Enumerated type consisting of the following options:
  • ooHorizontal (=0)
  • ooVertical (=1)
  • ooForwardDiagonal (=2)
  • ooBackwardDiagonal (=3)
  • ooRectangular (=4)
  • ooCircular (=5)
 ooHorizontal
FillGradientStartColor Determines the gradient's start color for the Profile Fill.
Profile Fill is not available in the Lite version.
Color Color.LightYellow
FillHorizontal Determines the direction of the profile fill.
Profile Fill is not available in the Lite version.
Boolean False
FillReference Determines the reference line the profile fill will be drawn against.
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:
  • loNone (=0)
  • loCustom (=1)
 loCustom
LineStyle Determines the style the profile line is displayed with. Enumerated type consisting of the following options:
  • soSolid (=1)
  • soDash (=2)
  • soDot (=3)
  • soDashDot (=4)
  • soDashDotDot (=5)
 soSolid
LineWidth Determines the width the profile line is displayed with. Enumerated type consisting of the following options:
  • woOnePoint (=1)
  • woTwoPoint (=2)
  • woThreePoint (=3)
  • woFourPoint (=4)
  • woFivePoint (=5)
 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
MarkerFillGradientEndColor Determines the gradient's end color for the Marker. Color Color.White
MarkerFillGradientOption Determines whether or not gradients will be drawn for the Marker. Enumerated type consisting of the following options:
  • goNone (=0)
  • goCustom (=1)
 goNone
MarkerFillGradientOrientation Determines the gradient's orientation for the Marker. Enumerated type consisting of the following options:
  • ooHorizontal (=0)
  • ooVertical (=1)
  • ooForwardDiagonal (=2)
  • ooBackwardDiagonal (=3)
  • ooRectangular (=4)
  • ooCircular (=5)
 ooHorizontal
MarkerFillGradientStartColor Determines the gradient's start color for the Marker. 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:
  • loNone (=0)
  • loCustom (=1)
 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 (=1)
  • msSquare (=2)
  • msDiamond (=3)
  • msTriangle (=4)
 msCircle
NoteColor Determines the color the Note will be displayed with. Color Color.Black
NoteData Determines the Note to display for each datetime (or x-value) interval specified in the NoteDataDatetime array. String() Array is initially empty
NoteDataDatetime Indicates at what x-value(s) the Note(s) should be displayed. Double() Array is initially empty
NoteDisplay Determines placement of the Note. Enumerated type consisting of the following options:
  • sdAbove(=0)
  • sdBelow(=1)
 sdAbove
NoteDisplayOffset Determines the number of pixels above/below the profile to display the Note. Integer 3
NoteFont Determines the Note's font characteristics. Font Arial, 8.25pt
NoteRotation Determines the angle of rotation, in degrees, for displaying the Note. Single 0
NumSamples Determines the number of samples for the Profile. Integer.  Valid range is 1..1,000,000.
For Lite versions, the valid range is 1..5,000.
100
RecessionLimitsMode Determines how the recession boundaries are defined.

For Manual mode, the profile's x/y data values defines the limits of the recession periods. FillReference property must be set.

For Automatic mode, the first date value for each pair of dates is treated as the start of a recession period, and the second date is treated as the end of a recession period.  FillReference property is not used.

 Enumerated type consisting of the following options:
  • rmAuto (=0)
  • rmManual (=1)
 rmManual 
SampleStep Determines 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
SellSignal Determines the Sell signal to display. Enumerated type consisting of the following options:
  • soArrowDown (=0)
  • soArrowUp (=1)
  • soTriangleDown (=2)
  • soTriangleUp (=3)
  • soCircle (=4)
  • soDiamond (=5)
 soArrowDown
SellSignalBorderColor Determines the color the border of the Sell signal will be displayed with. Color Color.Red
SellSignalData Indicates at what x-value(s) the Sell signal(s) should be displayed. Double() Array is initially empty
SellSignalDisplay Determines placement of the Sell signal. Enumerated type consisting of the following options:
  • sdAbove(=0)
  • sdBelow(=1)
 sdAbove
SellSignalDisplayOffset Determines the number of pixels above/below the profile to display the Sell signal. Integer 3
SellSignalFillColor Determines the color the Sell signal will be filled with. Color Color.Red
SellSignalSize Determines the display size, in pixels, of the Sell signal. Integer 8
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
XScale Determines which X-axis scale the Profile is plotted against Integer 0
XValuesAlwaysIncreasing Indicates the x-values, of the Profile's datapoints, are increasing. If the Profile's x-values are always increasing then setting this property to True will improve the performance. The control does not need to compute the Profile's min and max values since these values are already known Boolean False
YScale Determines which Y-axis scale the Profile is plotted against Integer 0
YValuesAlwaysIncreasing Indicates the y-values, of the Profile's datapoints, are increasing. If the Profile's y-values are always increasing then setting this property to True will improve the performance. The control does not need to compute the Profile's min and max values since these values are already known Boolean False

 

See Also
Properties
Profile

 

 

© 2003 - 2013 ControlEng Corporation. All rights reserved.