Package com.grapecity.documents.excel.drawing

Interface ITrendline

public interface ITrendline
Represents a trendline in a chart. A trendline shows the trend, or direction, of data in a series.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clearFormats()
    Clears the formatting of the object.
    void
    delete()
    Deletes the object.
    double
    getBackward()
    Gets the number of periods (or units on a scatter chart) that the trendline extends backward.
    IDataLabel
    getDataLabel()
    Returns a IDataLabel object that represents the data label associated with the trendline.
    boolean
    getDisplayEquation()
    Gets whether to display the equation for the trendline (True if the equation for the trendline is displayed on the chart, in the same data label as the R-squared value).
    boolean
    getDisplayRSquared()
    Gets whether to display the R-squared value (True if the R-squared value of the trendline is displayed on the chart, in the same data label as the equation).
    IChartFormat
    getFormat()
    Returns the format for chart elements.
    double
    getForward()
    Gets the number of periods (or units on a scatter chart) that the trendline extends forward.
    int
    getIndex()
    Returns the index number of the object within the collection of similar objects.
    double
    getIntercept()
    Gets the point where the trendline crosses the value axis.
    String
    getName()
    Gets the name of the object.
    boolean
    getNameIsAuto()
    Gets if the trendline's name is automatically determined.
    int
    getOrder()
    Gets the trendline order (an integer greater than 1) when the trendline type is Polynomial.
    ISeries
    getParent()
    Returns the parent object for the specified object.
    int
    getPeriod()
    Gets the period for the moving-average trendline.
    TrendlineType
    getType()
    Gets the trendline type.
    void
    setBackward(double value)
    Sets the number of periods (or units on a scatter chart) that the trendline extends backward.
    void
    setDisplayEquation(boolean value)
    Sets whether to display the equation for the trendline (True if the equation for the trendline is displayed on the chart, in the same data label as the R-squared value).
    void
    setDisplayRSquared(boolean value)
    Sets whether to display the R-squared value (True if the R-squared value of the trendline is displayed on the chart, in the same data label as the equation).
    void
    setForward(double value)
    Sets the number of periods (or units on a scatter chart) that the trendline extends forward.
    void
    setIntercept(double value)
    Sets the point where the trendline crosses the value axis.
    void
    setName(String name)
    Sets the name of the object.
    void
    setNameIsAuto(boolean value)
    Sets if the trendline's name is automatically determined.
    void
    setOrder(int value)
    Sets the trendline order (an integer is greater than or equal to 2 and less than or equal to 6) when the trendline type is Polynomial.
    void
    setPeriod(int value)
    Sets the period for the moving-average trendline.
    void
    setType(TrendlineType value)
    Sets the trendline type.

  • Method Details

    • getIndex

      int getIndex()
      Returns the index number of the object within the collection of similar objects.

    • getBackward

      double getBackward()
      Gets the number of periods (or units on a scatter chart) that the trendline extends backward.

    • setBackward

      void setBackward(double value)
      Sets the number of periods (or units on a scatter chart) that the trendline extends backward.

    • getDisplayEquation

      boolean getDisplayEquation()
      Gets whether to display the equation for the trendline (True if the equation for the trendline is displayed on the chart, in the same data label as the R-squared value). Setting this property to True automatically turns on data labels.

    • setDisplayEquation

      void setDisplayEquation(boolean value)
      Sets whether to display the equation for the trendline (True if the equation for the trendline is displayed on the chart, in the same data label as the R-squared value). Setting this property to True automatically turns on data labels.

    • getDisplayRSquared

      boolean getDisplayRSquared()
      Gets whether to display the R-squared value (True if the R-squared value of the trendline is displayed on the chart, in the same data label as the equation). Setting this property to True automatically turns on data labels.

    • setDisplayRSquared

      void setDisplayRSquared(boolean value)
      Sets whether to display the R-squared value (True if the R-squared value of the trendline is displayed on the chart, in the same data label as the equation). Setting this property to True automatically turns on data labels.

    • getFormat

      IChartFormat getFormat()
      Returns the format for chart elements.

    • getForward

      double getForward()
      Gets the number of periods (or units on a scatter chart) that the trendline extends forward.

    • setForward

      void setForward(double value)
      Sets the number of periods (or units on a scatter chart) that the trendline extends forward.

    • getIntercept

      double getIntercept()
      Gets the point where the trendline crosses the value axis.

    • setIntercept

      void setIntercept(double value)
      Sets the point where the trendline crosses the value axis.

    • getName

      String getName()
      Gets the name of the object.

    • setName

      void setName(String name)
      Sets the name of the object.

    • getNameIsAuto

      boolean getNameIsAuto()
      Gets if the trendline's name is automatically determined.

    • setNameIsAuto

      void setNameIsAuto(boolean value)
      Sets if the trendline's name is automatically determined.

    • getOrder

      int getOrder()
      Gets the trendline order (an integer greater than 1) when the trendline type is Polynomial.

    • setOrder

      void setOrder(int value)
      Sets the trendline order (an integer is greater than or equal to 2 and less than or equal to 6) when the trendline type is Polynomial.

    • getParent

      ISeries getParent()
      Returns the parent object for the specified object.

    • getPeriod

      int getPeriod()
      Gets the period for the moving-average trendline.

    • setPeriod

      void setPeriod(int value)
      Sets the period for the moving-average trendline.

    • getType

      TrendlineType getType()
      Gets the trendline type.

    • setType

      void setType(TrendlineType value)
      Sets the trendline type.

    • getDataLabel

      IDataLabel getDataLabel()
      Returns a IDataLabel object that represents the data label associated with the trendline.

    • clearFormats

      void clearFormats()
      Clears the formatting of the object.

    • delete

      void delete()
      Deletes the object.