com.aspose.slides

Class DataLabelCollection

java.lang.Object

com.aspose.slides.DomObject<ChartSeries>

com.aspose.slides.DataLabelCollection

All Implemented Interfaces:

com.aspose.ms.System.Collections.Generic.IGenericEnumerable<IDataLabel>, com.aspose.ms.System.Collections.IEnumerable<IDataLabel>, IChartComponent, IDataLabelCollection, IPresentationComponent, ISlideComponent, java.lang.Iterable<IDataLabel>

public class DataLabelCollection
extends DomObject<ChartSeries>
implements IDataLabelCollection

Represents a series labels.

Method Summary

Modifier and Type	Method and Description
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() Gets the default data label format.
IChartLinesFormat	getLeaderLinesFormat() Represents data labels leader lines format.
IChartSeries	getParentSeries() Gets the parent series.
IPresentation	getPresentation() Returns the parent presentation of a FillFormat.
IBaseSlide	getSlide() Returns the parent slide of a FillFormat.
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.Generic.IGenericEnumerator<IDataLabel>	iterator() Returns an enumerator that iterates through the collection.
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IDataLabel>	iteratorJava() Returns a java iterator for the entire collection.

Methods inherited from class com.aspose.slides.DomObject

getParent_Immediate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getChart

public final IChart getChart()

Returns the parent chart. Read-only IChart.

Specified by:

getChart in interface IChartComponent

iterator

public final com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IDataLabel> iterator()

Returns an enumerator that iterates through the collection.

Specified by:

iterator in interface com.aspose.ms.System.Collections.Generic.IGenericEnumerable<IDataLabel>

Specified by:

iterator in interface com.aspose.ms.System.Collections.IEnumerable<IDataLabel>

Specified by:

iterator in interface java.lang.Iterable<IDataLabel>

Returns:

A IGenericEnumerator that can be used to iterate through the collection.

iteratorJava

public final com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IDataLabel> iteratorJava()

Returns a java iterator for the entire collection.

Returns:

An Iterator for the entire collection.

isVisible

public final boolean isVisible()

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

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 final 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

getCountOfVisibleDataLabels

public final int getCountOfVisibleDataLabels()

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

Specified by:

getCountOfVisibleDataLabels in interface IDataLabelCollection

getCount

public final int getCount()

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

Specified by:

getCount in interface IDataLabelCollection

getDefaultDataLabelFormat

public final IDataLabelFormat getDefaultDataLabelFormat()

Gets the default data label format. Read-only IDataLabelFormat.

Specified by:

getDefaultDataLabelFormat in interface IDataLabelCollection

getLeaderLinesFormat

public final IChartLinesFormat getLeaderLinesFormat()

Represents data labels leader lines format. Read-only IChartLinesFormat.

Example:
  
 Presentation pres = new Presentation("pres.pptx");
 try {
     IChart chart = (IChart) pres.getSlides().get_Item(0).getShapes().get_Item(0);
     IChartSeriesCollection series = chart.getChartData().getSeries();
     IDataLabelCollection labels = series.get_Item(0).getLabels();
     labels.getLeaderLinesFormat().getLine().getFillFormat().setFillType(FillType.Solid);
     labels.getLeaderLinesFormat().getLine().getFillFormat().getSolidFillColor().setColor(new java.awt.Color(255, 0, 0, 255));
 } finally {
     if (pres != null) pres.dispose();
 }
  
  

Specified by:

getLeaderLinesFormat in interface IDataLabelCollection

getParentSeries

public final IChartSeries getParentSeries()

Gets the parent series. Read-only IChartSeries.

Specified by:

getParentSeries in interface IDataLabelCollection

indexOf

public final 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 final IDataLabel get_Item(int index)

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

Alternate way to access data label is: - series.getDataPoints().get_Item(i).getLabel() - manage label properties.

Specified by:

get_Item in interface IDataLabelCollection

getSlide

public final IBaseSlide getSlide()

Returns the parent slide of a FillFormat. Read-only BaseSlide.

Specified by:

getSlide in interface ISlideComponent

getPresentation

public final IPresentation getPresentation()

Returns the parent presentation of a FillFormat. Read-only IPresentation.

Specified by:

getPresentation in interface IPresentationComponent