Package com.grapecity.documents.excel.drawing

Interface ILegendKey

public interface ILegendKey
Represents a legend key in a chart legend.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clearFormats()
    Clears the formatting of the object.
    void
    delete()
    Deletes the object.
    IChartFormat
    getFormat()
    Returns the IChartFormat object.
    boolean
    getInvertIfNegative()
    Gets whether the pattern is inverted when the number is negative (True if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number).
    IChartFormat
    getMarkerFormat()
    Gets market format.
    int
    getMarkerSize()
    Returns the data-marker size, in points.
    MarkerStyle
    getMarkerStyle()
    Returns the marker style for a legend key in a line chart, scatter chart, or radar chart.
    ILegendEntry
    getParent()
    Returns the parent object for the specified object.
    double
    getPictureUnit()
    Returns the unit for each picture on the chart if the Microsoft.Office.Interop.Excel.LegendKey.PictureType property is set to StackScale (if not, this property is ignored).
    boolean
    getShadow()
    Gets a boolean value indicating whether the font is a shadow font or if the object has a shadow.
    boolean
    getSmooth()
    Gets a boolean value indicating whether curve smoothing is turned on for the line chart or scatter chart.
    void
    setInvertIfNegative(boolean value)
    Sets whether the pattern is inverted when the number is negative (True if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number).
    void
    setMarkerSize(int value)
    Sets the data-marker size, in points.
    void
    setMarkerStyle(MarkerStyle value)
    Sets the marker style for a legend key in a line chart, scatter chart, or radar chart.
    void
    setPictureUnit(double value)
    Sets the unit for each picture on the chart if the Microsoft.Office.Interop.Excel.LegendKey.PictureType property is set to StackScale (if not, this property is ignored).
    void
    setShadow(boolean value)
    Sets a boolean value indicating whether the font is a shadow font or if the object has a shadow.
    void
    setSmooth(boolean value)
    Sets a boolean value indicating whether curve smoothing is turned on for the line chart or scatter chart.

  • Method Details

    • getFormat

      IChartFormat getFormat()
      Returns the IChartFormat object.

    • getInvertIfNegative

      boolean getInvertIfNegative()
      Gets whether the pattern is inverted when the number is negative (True if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number).

    • setInvertIfNegative

      void setInvertIfNegative(boolean value)
      Sets whether the pattern is inverted when the number is negative (True if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number).

    • getMarkerFormat

      IChartFormat getMarkerFormat()
      Gets market format.

    • getMarkerSize

      int getMarkerSize()
      Returns the data-marker size, in points.

    • setMarkerSize

      void setMarkerSize(int value)
      Sets the data-marker size, in points.

    • getMarkerStyle

      MarkerStyle getMarkerStyle()
      Returns the marker style for a legend key in a line chart, scatter chart, or radar chart.

    • setMarkerStyle

      void setMarkerStyle(MarkerStyle value)
      Sets the marker style for a legend key in a line chart, scatter chart, or radar chart.

    • getParent

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

    • getPictureUnit

      double getPictureUnit()
      Returns the unit for each picture on the chart if the Microsoft.Office.Interop.Excel.LegendKey.PictureType property is set to StackScale (if not, this property is ignored).

    • setPictureUnit

      void setPictureUnit(double value)
      Sets the unit for each picture on the chart if the Microsoft.Office.Interop.Excel.LegendKey.PictureType property is set to StackScale (if not, this property is ignored).

    • getShadow

      boolean getShadow()
      Gets a boolean value indicating whether the font is a shadow font or if the object has a shadow.

    • setShadow

      void setShadow(boolean value)
      Sets a boolean value indicating whether the font is a shadow font or if the object has a shadow.

    • getSmooth

      boolean getSmooth()
      Gets a boolean value indicating whether curve smoothing is turned on for the line chart or scatter chart. Applies only to line and scatter charts.

    • setSmooth

      void setSmooth(boolean value)
      Sets a boolean value indicating whether curve smoothing is turned on for the line chart or scatter chart. Applies only to line and scatter charts.

    • clearFormats

      void clearFormats()
      Clears the formatting of the object.

    • delete

      void delete()
      Deletes the object.