If the setCurveFit() method selects a polynomial fit line across a series of risers (i.e., setCurveFit (FIT_POLYNOMIAL)), these methods get/set the order (the largest power to which "x" is raised) for the polynomial fit. The default value is 3. It may be set to a value in the range 0...10.
SYNTAX:
int getCurveFitPolynomialOrder(); int getCurveFitPolynomialOrder (IdentObj id); int getCurveFitPolynomialOrder (int seriesID); void setCurveFitPolynomialOrder (int newValue); void setCurveFitPolynomialOrder (IdentObj id, int newValue); void setCurveFitPolynomialOrder (int seriesID, int newValue);
INPUT:
id; object ID returned by a getObjectID() method (e.g., getSeries())
seriesID; Series Number
newValue; order for the polynomial fit (0...10)
RETURN:
int; Value assigned by setCurveFitPolynomialOrder()
EXAMPLE:
setDepthRadius (0); setCurveFitType (1, 3); setCurveFitPolynomialOrder (1, 3);
NOTES:
If a specific object is not identified with the input parameters id or seriesID, these methods get/set the associated value (if any) for the first item in the selection list.
ALSO SEE:
These methods get/set a curve fit line. The selected curve type will draw across one or more series of risers in a chart.
SYNTAX:
int getCurveFitType(); int getCurveFitType (IdentObj id); int getCurveFitType (int seriesID); void setCurveFitType (int newValue); void setCurveFitType (IdentObj id, int newValue); void setCurveFitType (int seriesID, int newValue);
INPUT:
id; object ID returned by a getObjectID() method (e.g., getSeries())
seriesID; Series Number
newValue; Curve fit type (0...11). Use one of the following CurveFitType constants:
FIT_NONE = 0 // None FIT_LINEAR = 1 // Linear regression curve fit line FIT_QUADRATIC = 2 // Quadratic curve fit line FIT_POLYNOMIAL = 3 // Polynomial fit line FIT_HYPERBOLIC = 4 // Hyperbolic curve fit line FIT_LOGARITHMIC = 5 // Logarithmic curve fit line FIT_MODHYPERBOLIC = 6 // Modified hyperbolic FIT_RATIONAL = 7 // Rational curve fit line FIT_EXPONENTIAL = 8 // Exponential curve fit line FIT_MODEXPONENTIAL = 9 // Modified exponential FIT_LOGQUADRATIC = 10 // Logarithmic/Quadratic curve fit line FIT_GEOMETRIC = 11 // Geometric curve fit line
RETURN:
int; The curve fit type (0...11) selected by setCurveFitType()
EXAMPLE:
setDepthRadius (0); setCurveFitType (1, 11);
NOTES:
If a specific object is not identified with the input parameters id or seriesID, these methods get/set the associated value (if any) for the first item in the selection list.
ALSO SEE:
This method gets the number of reference lines that have been defined in a chart.
SYNTAX:
int getReferenceLineCount();
INPUT:
None
RETURN:
int; number of reference lines (0...2)
EXAMPLE:
setDepthRadius (0); setGraphType (21); setReferenceLine (getY1Axis(), 0, 50); setLineWidth (getReferenceLine (getY1Axis(), 0), 3); setFillColor (getReferenceLine (getY1Axis(), 0), new Color (255, 0, 0)); setReferenceLine (getY2Axis(), 1, getReferenceLineValue (getY1Axis(), 0)); setLineWidth (getReferenceLine (getY2Axis(), 1), getReferenceLineCount()); setFillColor (getReferenceLine (getY2Axis(), 1), new Color (255, 0, 0));
ALSO SEE:
getReferenceLineValue(), referenceLineInsert(), removeReferenceLineObject(), setReferenceLine()
This method returns the location/value at which a specified reference line (nIndex) is drawn on a specified axis (axisObj).
SYNTAX:
double getReferenceLineValue (IdentObj axisObj, int nIndex)
INPUT:
axisObj; object ID returned by a getObject() method (e.g., getY1Axis().
nIndex; reference line index number (0...2)
RETURN:
double; the location/value of the reference line
EXAMPLE:
setGraphType (21); setDepthRadius (0); setReferenceLine (getY1Axis(), 0, 50); setLineWidth (getReferenceLine (getY1Axis(), 0), 3); setFillColor (getReferenceLine (getY1Axis(), 0), new Color (255, 0, 0)); setReferenceLine (getY2Axis(), 1, getReferenceLineValue (getY1Axis(), 0)); setLineWidth (getReferenceLine (getY2Axis(), 1), 3); setFillColor (getReferenceLine (getY2Axis(), 1), new Color (255, 0, 0));
ALSO SEE:
getReferenceLineCount(), referenceLineInsert(), removeReferenceLineObject(), setReferenceLine()
This method inserts a reference line into an ordered position.
SYNTAX:
int referenceLineInsert (IdentObj axisObj, int nIndex, double nPosition);
INPUT:
axisObj: object ID of an axis (e.g., getY1Axis())
nIndex: reference line index number (0...2)
nPosition: reference line position
RETURN:
int; inserted position
ALSO SEE:
getReferenceLineCount(), getReferernceLineValue(), removeReferenceLineObject(), setReferenceLine()
This method removes a reference line object.
SYNTAX:
void removeReferenceLineObject (IdentObj axisObj, int nIndex)
INPUT:
axisObj: object ID of an axis (e.g., getY1Axis())
nIndex: reference line index number
RETURN:
void;
ALSO SEE:
getReferenceLineValue(), referenceLineInsert(), getReferenceLineCount(), setReferenceLine()
This method defines a reference line to be drawn in a chart.
SYNTAX:
void setReferenceLine (IdentObj axisObj, int nIndex, double nPosition)
INPUT:
axisObj; object ID of an axis object returned by a getObjectID() method (e.g., getY1Axis())
nIndex; reference line index number (0...2)
nPosition; reference line position
RETURN:
void;
EXAMPLE:
setDepthAngle (0); setDepthRadius (0); setReferenceLine (getY1Axis(), 0, 50); setLineWidth (getReferenceLine (getY1Axis(), 0), 3); setFillColor (getReferenceLine (getY1Axis(), 0), new Color (255, 0, 0));
ALSO SEE:
getReferenceLineValue(), referenceLineInsert(), removeReferenceLineObject(), getReferenceLineCount()