com.aspose.slides
Class DataLabelCollection

java.lang.Object
  extended by com.aspose.slides.DataLabelCollection
All Implemented Interfaces:
com.aspose.ms.System.Collections.IEnumerable, IChartComponent, IDataLabelCollection, java.lang.Iterable

public class DataLabelCollection
extends java.lang.Object
implements IDataLabelCollection

Represents a series labels.


Method Summary
 IDataLabel get_Item(int index)
           Gets the data label for the data point with the specified index.
 IChart getChart()
           Returns the parent chart.
 int getCount()
           Gets the number of all data labels in the collection.
 int getCountOfVisibleDataLabels()
           Gets the number of visible data labels in the collection.
 IDataLabelFormat getDefaultDataLabelFormat()
           
 boolean getDelete()
          Deprecated. 
 Format getFormat()
          Deprecated. 
 boolean getLinkedSource()
          Deprecated. 
 java.lang.String getNumberFormat()
          Deprecated. 
 IChartSeries getParentSeries()
           
 int getPosition()
          Deprecated. 
 java.lang.String getSeparator()
          Deprecated. 
 boolean getShowBubbleSize()
          Deprecated. 
 boolean getShowCategoryName()
          Deprecated. 
 boolean getShowLeaderLines()
          Deprecated. 
 boolean getShowLegendKey()
          Deprecated. 
 boolean getShowPercentage()
          Deprecated. 
 boolean getShowSeriesName()
          Deprecated. 
 boolean getShowValue()
          Deprecated. 
 void hide()
           Make data label hidden by default by setting all Show*-flags (ShowValue, ...) of the DefaultDataLabelFormat property to false state.
 int indexOf(IDataLabel value)
           Returns an index of the specified DataLabel in the collection.
 boolean isVisible()
           False means that data label is not visible by default (and so all Show*-flags (ShowValue, ...) of the DefaultDataLabelFormat property are false).
 com.aspose.ms.System.Collections.IEnumerator iterator()
           Returns an enumerator for the entire collection.
 void setDelete(boolean value)
          Deprecated. 
 void setFormat(Format value)
          Deprecated. 
 void setLinkedSource(boolean value)
          Deprecated. 
 void setNumberFormat(java.lang.String value)
          Deprecated. 
 void setPosition(int value)
          Deprecated. 
 void setSeparator(java.lang.String value)
          Deprecated. 
 void setShowBubbleSize(boolean value)
          Deprecated. 
 void setShowCategoryName(boolean value)
          Deprecated. 
 void setShowLeaderLines(boolean value)
          Deprecated. 
 void setShowLegendKey(boolean value)
          Deprecated. 
 void setShowPercentage(boolean value)
          Deprecated. 
 void setShowSeriesName(boolean value)
          Deprecated. 
 void setShowValue(boolean value)
          Deprecated. 
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getChart

public IChart getChart()

Returns the parent chart. Read-only IChart.

Specified by:
getChart in interface IChartComponent

iterator

public com.aspose.ms.System.Collections.IEnumerator iterator()

Returns an enumerator for the entire collection.

Specified by:
iterator in interface com.aspose.ms.System.Collections.IEnumerable
Specified by:
iterator in interface java.lang.Iterable

getNumberFormat

@Deprecated
public java.lang.String getNumberFormat()
Deprecated. 

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


setNumberFormat

@Deprecated
public void setNumberFormat(java.lang.String value)
Deprecated. 


getLinkedSource

@Deprecated
public boolean getLinkedSource()
Deprecated. 

Gets and sets a reference to the worksheet


setLinkedSource

@Deprecated
public void setLinkedSource(boolean value)
Deprecated. 


getDelete

@Deprecated
public boolean getDelete()
Deprecated. 

Returns or sets delete flag. True means that data label is not visible by default (and so all Show*-flags (ShowValue, ...) of the DefaultDataLabelFormat property are false).


setDelete

@Deprecated
public void setDelete(boolean value)
Deprecated. 


isVisible

public boolean isVisible()

False means that data label is not visible by default (and so all Show*-flags (ShowValue, ...) of the DefaultDataLabelFormat property are false).


If data label is visible by default you can make it hidden by default with Hide() method. But if data label is not visible by default (IsVisible is false) you can make data label "visible by default" with setting Show*-flags (ShowValue, ...) of the DefaultDataLabelFormat property to true state.

Specified by:
isVisible in interface IDataLabelCollection

hide

public void hide()

Make data label hidden by default by setting all Show*-flags (ShowValue, ...) of the DefaultDataLabelFormat property to false state. IsVisible will be false after this.


If data label is not visible by default (IsVisible is false) you can make data label "visible by default" with setting Show*-flags (ShowValue, ...) of the DefaultDataLabelFormat property to true state.

Specified by:
hide in interface IDataLabelCollection

getFormat

@Deprecated
public Format getFormat()
Deprecated. 

Represents the format of the data labels. Read/write Charts.Format.


setFormat

@Deprecated
public void setFormat(Format value)
Deprecated. 


getPosition

@Deprecated
public int getPosition()
Deprecated. 

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


setPosition

@Deprecated
public void setPosition(int value)
Deprecated. 


getShowLegendKey

@Deprecated
public boolean getShowLegendKey()
Deprecated. 

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


setShowLegendKey

@Deprecated
public void setShowLegendKey(boolean value)
Deprecated. 


getShowLeaderLines

@Deprecated
public boolean getShowLeaderLines()
Deprecated. 

Represents a specified chart's data label leader line display behavior. True if the data label leader line is visible. Read/write bool.


setShowLeaderLines

@Deprecated
public void setShowLeaderLines(boolean value)
Deprecated. 


getShowCategoryName

@Deprecated
public boolean getShowCategoryName()
Deprecated. 

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 bool.


setShowCategoryName

@Deprecated
public void setShowCategoryName(boolean value)
Deprecated. 


getShowValue

@Deprecated
public boolean getShowValue()
Deprecated. 

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


setShowValue

@Deprecated
public void setShowValue(boolean value)
Deprecated. 


getShowPercentage

@Deprecated
public boolean getShowPercentage()
Deprecated. 

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


setShowPercentage

@Deprecated
public void setShowPercentage(boolean value)
Deprecated. 


getShowSeriesName

@Deprecated
public boolean getShowSeriesName()
Deprecated. 

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 bool.


setShowSeriesName

@Deprecated
public void setShowSeriesName(boolean value)
Deprecated. 


getShowBubbleSize

@Deprecated
public boolean getShowBubbleSize()
Deprecated. 

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


setShowBubbleSize

@Deprecated
public void setShowBubbleSize(boolean value)
Deprecated. 


getSeparator

@Deprecated
public java.lang.String getSeparator()
Deprecated. 

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


setSeparator

@Deprecated
public void setSeparator(java.lang.String value)
Deprecated. 


getCountOfVisibleDataLabels

public int getCountOfVisibleDataLabels()

Gets the number of visible data labels in the collection. Read-only int.

Specified by:
getCountOfVisibleDataLabels in interface IDataLabelCollection

getCount

public int getCount()

Gets the number of all data labels in the collection. Read-only int.

Specified by:
getCount in interface IDataLabelCollection

getDefaultDataLabelFormat

public IDataLabelFormat getDefaultDataLabelFormat()
Specified by:
getDefaultDataLabelFormat in interface IDataLabelCollection

getParentSeries

public IChartSeries getParentSeries()
Specified by:
getParentSeries in interface IDataLabelCollection

indexOf

public int indexOf(IDataLabel value)

Returns an index of the specified DataLabel in the collection.

Specified by:
indexOf in interface IDataLabelCollection
Parameters:
value - DataLabel to find.
Returns:
Index of a DataLabel or -1 if DataLabel not from this collection.

get_Item

public IDataLabel get_Item(int index)

Gets the data label for the data point with the specified index.


Alternate way to access data label is: - SeriesEx.DataPoints[i].Label - manage label properties.

Specified by:
get_Item in interface IDataLabelCollection