Package com.grapecity.documents.excel.drawing

Interface IDataLabel

public interface IDataLabel
Represents the data label on a chart point or trendline.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    delete()
    Deletes the object.
    boolean
    getAutoText()
    Gets whether the object automatically generates appropriate text based on context.
    TextDirection
    getDirection()
    Gets the text direction.
    IFontFormat
    getFont()
    Gets the IFontFormat object that represents the font of the specifiedobject.
    IChartFormat
    getFormat()
    Returns the IChartFormat object.
    String
    getNumberFormat()
    Gets the format code for the object.
    boolean
    getNumberFormatLinked()
    Gets whether the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).
    int
    getOrientation()
    Gets the text orientation.
    Object
    getParent()
    Returns the parent object for the specified object.
    DataLabelPosition
    getPosition()
    Gets the position of the data label.
    String
    getSeparator()
    Gets an object that represents the separator used for the data label on a chart.
    boolean
    getShowBubbleSize()
    Gets whether to show the bubble size (True to show the bubble size for the data label on a chart; False to hide).
    boolean
    getShowCategoryName()
    Gets whether to show the category name (True to display the category name for the data label on a chart; False to hide).
    boolean
    getShowLegendKey()
    Gets whether the data label legend key is visible.
    boolean
    getShowPercentage()
    Gets whether to display the percentage (True to display the percentage value for the data label on a chart; False to hide).
    boolean
    getShowSeriesName()
    Gets a Boolean to indicate the series name display behavior for the data labels on a chart.
    boolean
    getShowValue()
    Gets a Boolean that corresponds to a specified chart's data label value display behavior.
    String
    getText()
    Gets the text for the specified object.
    ITextFrame
    getTextFrame()
    Returns the ITextFrame object that contains the text and font styleproperties for the specified data label.
    void
    setAutoText(boolean value)
    Sets whether the object automatically generates appropriate text based on context.
    void
    setDirection(TextDirection value)
    Sets the text direction.
    void
    setNumberFormat(String value)
    Sets the format code for the object.
    void
    setNumberFormatLinked(boolean value)
    Sets whether the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).
    void
    setOrientation(int value)
    Sets the text orientation.
    void
    setPosition(DataLabelPosition value)
    Sets the position of the data label.
    void
    setSeparator(String value)
    Sets an object that represents the separator used for the data label on a chart.
    void
    setShowBubbleSize(boolean value)
    Sets whether to show the bubble size (True to show the bubble size for the data label on a chart; False to hide).
    void
    setShowCategoryName(boolean value)
    Sets whether to show the category name (True to display the category name for the data label on a chart; False to hide).
    void
    setShowLegendKey(boolean value)
    Sets whether the data label legend key is visible.
    void
    setShowPercentage(boolean value)
    Sets whether to display the percentage (True to display the percentage value for the data label on a chart; False to hide).
    void
    setShowSeriesName(boolean value)
    Sets a Boolean to indicate the series name display behavior for the data label on a chart.
    void
    setShowValue(boolean value)
    Sets a Boolean that corresponds to a specified chart's data label value display behavior.
    void
    setText(String value)
    Sets the text for the specified object.

  • Method Details

    • getAutoText

      boolean getAutoText()
      Gets whether the object automatically generates appropriate text based on context.

    • setAutoText

      void setAutoText(boolean value)
      Sets whether the object automatically generates appropriate text based on context.

    • getFont

      IFontFormat getFont()
      Gets the IFontFormat object that represents the font of the specifiedobject.

    • getFormat

      IChartFormat getFormat()
      Returns the IChartFormat object.

    • getNumberFormat

      String getNumberFormat()
      Gets the format code for the object.

    • setNumberFormat

      void setNumberFormat(String value)
      Sets the format code for the object.

    • getNumberFormatLinked

      boolean getNumberFormatLinked()
      Gets whether the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).

    • setNumberFormatLinked

      void setNumberFormatLinked(boolean value)
      Sets whether the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).

    • getParent

      Object getParent()
      Returns the parent object for the specified object. The return value type changes from IPoint to object in version 7.0.0.This breaking change will cause a compilation failure or runtime error. The return value could be IPoint or ITrendline.

    • getPosition

      DataLabelPosition getPosition()
      Gets the position of the data label.

    • setPosition

      void setPosition(DataLabelPosition value)
      Sets the position of the data label.

    • getSeparator

      String getSeparator()
      Gets an object that represents the separator used for the data label on a chart.

    • setSeparator

      void setSeparator(String value)
      Sets an object that represents the separator used for the data label on a chart.

    • getShowBubbleSize

      boolean getShowBubbleSize()
      Gets whether to show the bubble size (True to show the bubble size for the data label on a chart; False to hide).

    • setShowBubbleSize

      void setShowBubbleSize(boolean value)
      Sets whether to show the bubble size (True to show the bubble size for the data label on a chart; False to hide).

    • getShowCategoryName

      boolean getShowCategoryName()
      Gets whether to show the category name (True to display the category name for the data label on a chart; False to hide).

    • setShowCategoryName

      void setShowCategoryName(boolean value)
      Sets whether to show the category name (True to display the category name for the data label on a chart; False to hide).

    • getShowLegendKey

      boolean getShowLegendKey()
      Gets whether the data label legend key is visible.

    • setShowLegendKey

      void setShowLegendKey(boolean value)
      Sets whether the data label legend key is visible.

    • getShowPercentage

      boolean getShowPercentage()
      Gets whether to display the percentage (True to display the percentage value for the data label on a chart; False to hide).

    • setShowPercentage

      void setShowPercentage(boolean value)
      Sets whether to display the percentage (True to display the percentage value for the data label on a chart; False to hide).

    • getShowSeriesName

      boolean getShowSeriesName()
      Gets a Boolean to indicate the series name display behavior for the data labels on a chart. True to show the series name. False to hide.

    • setShowSeriesName

      void setShowSeriesName(boolean value)
      Sets a Boolean to indicate the series name display behavior for the data label on a chart. True to show the series name. False to hide.

    • getShowValue

      boolean getShowValue()
      Gets a Boolean that corresponds to a specified chart's data label value display behavior. True displays the values. False to hide.

    • setShowValue

      void setShowValue(boolean value)
      Sets a Boolean that corresponds to a specified chart's data label value display behavior. True displays the values. False to hide.

    • getText

      String getText()
      Gets the text for the specified object.

    • setText

      void setText(String value)
      Sets the text for the specified object.

    • getOrientation

      int getOrientation()
      Gets the text orientation.

    • setOrientation

      void setOrientation(int value)
      Sets the text orientation. Can be an integer value from –90 to 90 degrees.

    • getDirection

      TextDirection getDirection()
      Gets the text direction.

    • setDirection

      void setDirection(TextDirection value)
      Sets the text direction.

    • getTextFrame

      ITextFrame getTextFrame()
      Returns the ITextFrame object that contains the text and font styleproperties for the specified data label.

    • delete

      void delete()
      Deletes the object.