com.aspose.slides

Interfaces

Classes

Exceptions

com.aspose.slides

Interface IDataLabelFormat

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      IFormat getFormat()
      Represents the format of the data label.
      java.lang.String getNumberFormat()
      Represents the format string for the DataLabels object.
      int getPosition()
      Represents the position of the data label.
      java.lang.String getSeparator()
      Sets or returns a Variant representing the separator used for the data labels on a chart.
      boolean getShowBubbleSize()
      Represents a specified chart's data label bubble size value display behavior.
      boolean getShowCategoryName()
      Represents a specified chart's data label category name display behavior.
      boolean getShowLabelAsDataCallout()
      Determines either specified chart's data label will be displayed as data callout or as data label.
      boolean getShowLabelValueFromCell()
      Represents a specified chart's data label cell value display behavior.
      boolean getShowLeaderLines()
      Represents a specified chart's data label leader lines display behavior.
      boolean getShowLegendKey()
      Represents a specified chart's data label legend key display behavior.
      boolean getShowPercentage()
      Represents a specified chart's data label percentage value display behavior.
      boolean getShowSeriesName()
      Returns or sets a Boolean to indicate the series name display behavior for the data labels on a chart.
      boolean getShowValue()
      Represents a specified chart's data label percentage value display behavior.
      boolean isNumberFormatLinkedToSource()
      Read/write boolean.
      void setNumberFormat(java.lang.String value)
      Represents the format string for the DataLabels object.
      void setNumberFormatLinkedToSource(boolean value)
      Read/write boolean.
      void setPosition(int value)
      Represents the position of the data label.
      void setSeparator(java.lang.String value)
      Sets or returns a Variant representing the separator used for the data labels on a chart.
      void setShowBubbleSize(boolean value)
      Represents a specified chart's data label bubble size value display behavior.
      void setShowCategoryName(boolean value)
      Represents a specified chart's data label category name display behavior.
      void setShowLabelAsDataCallout(boolean value)
      Determines either specified chart's data label will be displayed as data callout or as data label.
      void setShowLabelValueFromCell(boolean value)
      Represents a specified chart's data label cell value display behavior.
      void setShowLeaderLines(boolean value)
      Represents a specified chart's data label leader lines display behavior.
      void setShowLegendKey(boolean value)
      Represents a specified chart's data label legend key display behavior.
      void setShowPercentage(boolean value)
      Represents a specified chart's data label percentage value display behavior.
      void setShowSeriesName(boolean value)
      Returns or sets a Boolean to indicate the series name display behavior for the data labels on a chart.
      void setShowValue(boolean value)
      Represents a specified chart's data label percentage value display behavior.
    • Method Detail

      • isNumberFormatLinkedToSource

        boolean isNumberFormatLinkedToSource()

        Read/write boolean.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the IsNumberFormatLinkedToSource property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the IsNumberFormatLinkedToSource property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setNumberFormatLinkedToSource(val);" cause to all DataLabels.get_Item(i).isNumberFormatLinkedToSource() is equal to val).

      • setNumberFormatLinkedToSource

        void setNumberFormatLinkedToSource(boolean value)

        Read/write boolean.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the IsNumberFormatLinkedToSource property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the IsNumberFormatLinkedToSource property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setNumberFormatLinkedToSource(val);" cause to all DataLabels.get_Item(i).isNumberFormatLinkedToSource() is equal to val).

      • getNumberFormat

        java.lang.String getNumberFormat()

        Represents the format string for the DataLabels object. Read/write String.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the NumberFormat property for the new data labels in the DataLabelCollection collection. Represents the format string for the DataLabel objects. Set this property with value also sets this value to the NumberFormat property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setNumberFormat(val);" cause to all DataLabels.get_Item(i).getNumberFormat() is equal to val).

      • setNumberFormat

        void setNumberFormat(java.lang.String value)

        Represents the format string for the DataLabels object. Read/write String.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the NumberFormat property for the new data labels in the DataLabelCollection collection. Represents the format string for the DataLabel objects. Set this property with value also sets this value to the NumberFormat property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setNumberFormat(val);" cause to all DataLabels.get_Item(i).getNumberFormat() is equal to val).

      • getFormat

        IFormat getFormat()

        Represents the format of the data label. Read-only IFormat.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property represents the default format for the new data labels in the DataLabelCollection collection.

      • getPosition

        int getPosition()

        Represents the position of the data label. Read/write LegendDataLabelPosition.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the Position property for the new data labels in the DataLabelCollection collection. Represents the position for the DataLabel objects. Set this property with value also sets this value to the Position property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setPosition(val)" cause to all DataLabels.get_Item(i).getPosition() is equal to val).

      • setPosition

        void setPosition(int value)

        Represents the position of the data label. Read/write LegendDataLabelPosition.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the Position property for the new data labels in the DataLabelCollection collection. Represents the position for the DataLabel objects. Set this property with value also sets this value to the Position property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setPosition(val)" cause to all DataLabels.get_Item(i).getPosition() is equal to val).

      • getShowLegendKey

        boolean getShowLegendKey()

        Represents a specified chart's data label legend key display behavior. True if the data label legend key is visible. Read/write boolean.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowLegendKey property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowLegendKey property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowLegendKey(val);" cause to all DataLabels.get_Item(i).getShowLegendKey() is equal to val).

      • setShowLegendKey

        void setShowLegendKey(boolean value)

        Represents a specified chart's data label legend key display behavior. True if the data label legend key is visible. Read/write boolean.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowLegendKey property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowLegendKey property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowLegendKey(val);" cause to all DataLabels.get_Item(i).getShowLegendKey() is equal to val).

      • getShowValue

        boolean getShowValue()

        Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide. Read/write boolean.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowValue property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowValue property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowValue(val);" cause to all DataLabels.get_Item(i).getShowValue() is equal to val).

      • setShowValue

        void setShowValue(boolean value)

        Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide. Read/write boolean.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowValue property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowValue property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowValue(val);" cause to all DataLabels.get_Item(i).getShowValue() is equal to val).

      • getShowCategoryName

        boolean getShowCategoryName()

        Represents a specified chart's data label category name display behavior. True to display the category name for the data labels on a chart. False to hide. Read/write boolean.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowCategoryName property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowCategoryName property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowCategoryName(val);" cause to all DataLabels.get_Item(i).getShowCategoryName() is equal to val).

      • setShowCategoryName

        void setShowCategoryName(boolean value)

        Represents a specified chart's data label category name display behavior. True to display the category name for the data labels on a chart. False to hide. Read/write boolean.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowCategoryName property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowCategoryName property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowCategoryName(val);" cause to all DataLabels.get_Item(i).getShowCategoryName() is equal to val).

      • getShowSeriesName

        boolean getShowSeriesName()

        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. Read/write boolean.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowSeriesName property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowSeriesName property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowSeriesName(val);" cause to all DataLabels.get_Item(i).getShowSeriesName() is equal to val).

      • setShowSeriesName

        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. Read/write boolean.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowSeriesName property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowSeriesName property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowSeriesName(val);" cause to all DataLabels.get_Item(i).getShowSeriesName() is equal to val).

      • getShowPercentage

        boolean getShowPercentage()

        Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide. Read/write boolean.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowPercentage property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowPercentage property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowPercentage(val);" cause to all DataLabels.get_Item(i).getShowPercentage() is equal to val).

      • setShowPercentage

        void setShowPercentage(boolean value)

        Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide. Read/write boolean.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowPercentage property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowPercentage property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowPercentage(val);" cause to all DataLabels.get_Item(i).getShowPercentage() is equal to val).

      • getShowBubbleSize

        boolean getShowBubbleSize()

        Represents a specified chart's data label bubble size value display behavior. True displays the bubble size value. False to hide. Read/write boolean.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowBubbleSize property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowBubbleSize property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowBubbleSize(val);" cause to all DataLabels.get_Item(i).getShowBubbleSize() is equal to val).

      • setShowBubbleSize

        void setShowBubbleSize(boolean value)

        Represents a specified chart's data label bubble size value display behavior. True displays the bubble size value. False to hide. Read/write boolean.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowBubbleSize property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowBubbleSize property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowBubbleSize(val);" cause to all DataLabels.get_Item(i).getShowBubbleSize() is equal to val).

      • getShowLeaderLines

        boolean getShowLeaderLines()

        Represents a specified chart's data label leader lines display behavior. True displays the leader lines. False to hide. Read/write boolean.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowLeaderLines property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowLeaderLines property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowLeaderLines(val);" cause to all DataLabels.get_Item(i).getShowLeaderLines() is equal to val).

      • setShowLeaderLines

        void setShowLeaderLines(boolean value)

        Represents a specified chart's data label leader lines display behavior. True displays the leader lines. False to hide. Read/write boolean.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowLeaderLines property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowLeaderLines property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowLeaderLines(val);" cause to all DataLabels.get_Item(i).getShowLeaderLines() is equal to val).

      • getShowLabelAsDataCallout

        boolean getShowLabelAsDataCallout()

        Determines either specified chart's data label will be displayed as data callout or as data label.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowLabelAsDataCallout property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowLabelAsDataCallout property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowLabelAsDataCallout(val);" cause to all DataLabels.get_Item(i).getShowLabelAsDataCallout() is equal to val).

      • setShowLabelAsDataCallout

        void setShowLabelAsDataCallout(boolean value)

        Determines either specified chart's data label will be displayed as data callout or as data label.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowLabelAsDataCallout property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowLabelAsDataCallout property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowLabelAsDataCallout(val);" cause to all DataLabels.get_Item(i).getShowLabelAsDataCallout() is equal to val).

      • getShowLabelValueFromCell

        boolean getShowLabelValueFromCell()

        Represents a specified chart's data label cell value display behavior. True displays cell value. False to hide. Read/write boolean.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowLabelValueFromCell property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowLabelValueFromCell property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowLabelValueFromCell(val);" cause to all DataLabels.get_Item(i).getShowLabelValueFromCell() is equal to val).

      • setShowLabelValueFromCell

        void setShowLabelValueFromCell(boolean value)

        Represents a specified chart's data label cell value display behavior. True displays cell value. False to hide. Read/write boolean.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowLabelValueFromCell property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowLabelValueFromCell property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowLabelValueFromCell(val);" cause to all DataLabels.get_Item(i).getShowLabelValueFromCell() is equal to val).

      • getSeparator

        java.lang.String getSeparator()

        Sets or returns a Variant representing the separator used for the data labels on a chart. Read/write String.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the Separator property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the Separator property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setSeparator(val);" cause to all DataLabels.get_Item(i).getSeparator() is equal to val).

      • setSeparator

        void setSeparator(java.lang.String value)

        Sets or returns a Variant representing the separator used for the data labels on a chart. Read/write String.


        If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the Separator property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the Separator property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setSeparator(val);" cause to all DataLabels.get_Item(i).getSeparator() is equal to val).