com.aspose.words

Class ChartDataLabel

  • java.lang.Object
    • com.aspose.words.ChartDataLabel
  • All Implemented Interfaces:
    java.lang.Cloneable
    public class ChartDataLabel 
    extends java.lang.Object

Represents data label on a chart point or trendline.
On a series, the ChartDataLabel object is a member of the ChartDataLabelCollection. The ChartDataLabelCollection contains a ChartDataLabel object for each point.

Property Getters/Setters Summary
intgetIndex()
Specifies the index of the containing element. This index shall determine which of the parent's children collection this element applies to. Default value is 0.
booleanisVisible()
Returns true if this data label has something to display.
ChartNumberFormatgetNumberFormat()
Returns number format of the parent element.
java.lang.StringgetSeparator()
void
setSeparator(java.lang.Stringvalue)
           Gets or sets string separator used for the data labels on a chart. The default is a comma, except for pie charts showing only category name and percentage, when a line break shall be used instead.
booleangetShowBubbleSize()
void
setShowBubbleSize(booleanvalue)
           Allows to specify if bubble size is to be displayed for the data labels on a chart. Applies only to Bubble charts. Default value is false.
booleangetShowCategoryName()
void
setShowCategoryName(booleanvalue)
           Allows to specify if category name is to be displayed for the data labels on a chart. Default value is false.
booleangetShowDataLabelsRange()
void
           Allows to specify if values from data labels range to be displayed in the data labels. Default value is false.
booleangetShowLeaderLines()
void
setShowLeaderLines(booleanvalue)
           Allows to specify if data label leader lines need be shown. Default value is false.
booleangetShowLegendKey()
void
setShowLegendKey(booleanvalue)
           Allows to specify if legend key is to be displayed for the data labels on a chart. Default value is false.
booleangetShowPercentage()
void
setShowPercentage(booleanvalue)
           Allows to specify if percentage value is to be displayed for the data labels on a chart. Default value is false.
booleangetShowSeriesName()
void
setShowSeriesName(booleanvalue)
           Returns or sets 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. By default false.
booleangetShowValue()
void
setShowValue(booleanvalue)
           Allows to specify if values are to be displayed in the data labels. Default value is false.
 

    • Property Getters/Setters Detail

      • getIndex

        public int getIndex()
        
        Specifies the index of the containing element. This index shall determine which of the parent's children collection this element applies to. Default value is 0.
      • isVisible

        public boolean isVisible()
        
        Returns true if this data label has something to display.
      • getNumberFormat

        public ChartNumberFormat getNumberFormat()
        
        Returns number format of the parent element.
      • getSeparator/setSeparator

        public java.lang.String getSeparator() / public void setSeparator(java.lang.String value)
        
        Gets or sets string separator used for the data labels on a chart. The default is a comma, except for pie charts showing only category name and percentage, when a line break shall be used instead.
      • getShowBubbleSize/setShowBubbleSize

        public boolean getShowBubbleSize() / public void setShowBubbleSize(boolean value)
        
        Allows to specify if bubble size is to be displayed for the data labels on a chart. Applies only to Bubble charts. Default value is false.
      • getShowCategoryName/setShowCategoryName

        public boolean getShowCategoryName() / public void setShowCategoryName(boolean value)
        
        Allows to specify if category name is to be displayed for the data labels on a chart. Default value is false.
      • getShowDataLabelsRange/setShowDataLabelsRange

        public boolean getShowDataLabelsRange() / public void setShowDataLabelsRange(boolean value)
        
        Allows to specify if values from data labels range to be displayed in the data labels. Default value is false.
      • getShowLeaderLines/setShowLeaderLines

        public boolean getShowLeaderLines() / public void setShowLeaderLines(boolean value)
        
        Allows to specify if data label leader lines need be shown. Default value is false. Applies to Pie charts only. Leader lines create a visual connection between a data label and its corresponding data point.
      • getShowLegendKey/setShowLegendKey

        public boolean getShowLegendKey() / public void setShowLegendKey(boolean value)
        
        Allows to specify if legend key is to be displayed for the data labels on a chart. Default value is false.
      • getShowPercentage/setShowPercentage

        public boolean getShowPercentage() / public void setShowPercentage(boolean value)
        
        Allows to specify if percentage value is to be displayed for the data labels on a chart. Default value is false.
      • getShowSeriesName/setShowSeriesName

        public boolean getShowSeriesName() / public void setShowSeriesName(boolean value)
        
        Returns or sets 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. By default false.
      • getShowValue/setShowValue

        public boolean getShowValue() / public void setShowValue(boolean value)
        
        Allows to specify if values are to be displayed in the data labels. Default value is false.