com.spire.presentation.collections
Class ChartDataLabelCollection

java.lang.Object
  com.spire.presentation.collections.ChartDataLabelCollection

All Implemented Interfaces:

com.spire.ms.System.Collections.IEnumerable, java.lang.Iterable

public class ChartDataLabelCollection
extends java.lang.Object
implements com.spire.ms.System.Collections.IEnumerable

Represents a series labels.

Constructor Summary

ChartDataLabelCollection(ChartSeriesDataFormat parent)
Creates a new instance of DataLabels class.

ChartDataLabelCollection(ChartSeriesDataFormat parent, DataLabels label)

Method Summary

ChartDataLabel	add() Adds the new DataLabel at the end of a collection.
ChartDataLabel	get(int index) Gets the element at the specified index.
boolean	getBubbleSizeVisible() Indicates chart's data label bubble size value display behavior.
boolean	getCategoryNameVisible() Indicates chart's data label category name display behavior.
int	getCount() Gets the number of elements actually contained in the collection.
DataLabelShapeType	getDataLabelShapeType() Gets or sets shape type of data labels.
EffectDag	getEffect() Gets effects used for a chart.
FormatThreeD	getEffect3D() Gets 3D format of a chart.
FillFormat	getFill() Gets fill style properties of a chart.
boolean	getLabelValueVisible() Indicates chart's data label value display behavior.
IChartGridLine	getLeaderLines() Gets LeaderLines of chart.
boolean	getLeaderLinesVisible() Indicates chart's data label leader line display behavior.
boolean	getLegendKeyVisible() Indicates chart's data label legend key display behavior.
IChartGridLine	getLine() Gets line style properties of a chart.
java.lang.String	getNumberFormat() Represents the format string for the DataLabels object.
boolean	getPercentValueVisible() Indicates chart's data label percentage value display behavior.
ChartDataLabelPosition	getPosition() Represents the position of the data lable.
java.lang.String	getSeparator() Sets or returns a Variant representing the separator used for the data labels on a chart.
boolean	getSeriesNameVisible() Gets or sets a Boolean to indicate the series name display behavior for the data labels on a chart.
ITextFrameProperties	getTextProperties() Gets a text properties of this data labels Readonly .
boolean	hasDataSource() Gets and sets a reference to the worksheet
void	hasDataSource(boolean value) Gets and sets a reference to the worksheet
int	indexOf(ChartDataLabel value) Gets an index of the specified DataLabel in the collection.
boolean	isDelete() Gets or sets delete flag.
void	isDelete(boolean value) Gets or sets delete flag.
void	remove(ChartDataLabel value) Removes the first occurrence of a specific object from the collection.
void	setBubbleSizeVisible(boolean value) Sets chart's data label bubble size value display behavior.
void	setCategoryNameVisible(boolean value) Sets chart's data label category name display behavior.
void	setDataLabelShapeType(DataLabelShapeType value) Gets or sets shape type of data labels.
void	setLabelValueVisible(boolean value) Sets chart's data label value display behavior.
void	setLeaderLinesVisible(boolean value) Sets chart's data label leader line display behavior.
void	setLegendKeyVisible(boolean value) Sets chart's data label legend key display behavior.
void	setNumberFormat(java.lang.String value) Sets the format string for the DataLabels object.
void	setPercentValueVisible(boolean value) Sets chart's data label percentage value display behavior.
void	setPosition(ChartDataLabelPosition value) Sets the position of the data lable.
void	setSeparator(java.lang.String value) Sets or returns a Variant representing the separator used for the data labels on a chart.
void	setSeriesNameVisible(boolean value) Gets or sets a Boolean to indicate the series name display behavior for the data labels on a chart.

Constructor Detail

ChartDataLabelCollection

public ChartDataLabelCollection(ChartSeriesDataFormat parent,
                                DataLabels label)
                         throws DocumentEditException

Throws:

DocumentEditException

ChartDataLabelCollection

public ChartDataLabelCollection(ChartSeriesDataFormat parent)

Creates a new instance of DataLabels class.

Parameters:

parent - Parent series.

Throws:

java.lang.Exception

Method Detail

getNumberFormat

public java.lang.String getNumberFormat()

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

Returns:

setNumberFormat

public void setNumberFormat(java.lang.String value)

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

Parameters:

value -

hasDataSource

public boolean hasDataSource()

Gets and sets a reference to the worksheet

Returns:

hasDataSource

public void hasDataSource(boolean value)

Gets and sets a reference to the worksheet

Parameters:

value -

isDelete

public boolean isDelete()

Gets or sets delete flag.

Returns:

isDelete

public void isDelete(boolean value)

Gets or sets delete flag.

Parameters:

value -

getTextProperties

public ITextFrameProperties getTextProperties()

Gets a text properties of this data labels Readonly .

Returns:

getFill

public FillFormat getFill()

Gets fill style properties of a chart. Read-only .

Returns:

getLine

public IChartGridLine getLine()

Gets line style properties of a chart.

Returns:

getEffect

public EffectDag getEffect()

Gets effects used for a chart. Read-only .

Returns:

getEffect3D

public FormatThreeD getEffect3D()

Gets 3D format of a chart. Read-only .

Returns:

getPosition

public ChartDataLabelPosition getPosition()

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

Returns:

setPosition

public void setPosition(ChartDataLabelPosition value)

Sets the position of the data lable. Read/write .

Parameters:

value -

getLegendKeyVisible

public boolean getLegendKeyVisible()

Indicates chart's data label legend key display behavior. Read/write .

Returns:

setLegendKeyVisible

public void setLegendKeyVisible(boolean value)

Sets chart's data label legend key display behavior. Read/write .

Parameters:

value -

getLeaderLinesVisible

public boolean getLeaderLinesVisible()

Indicates chart's data label leader line display behavior. Read/write .

Returns:

setLeaderLinesVisible

public void setLeaderLinesVisible(boolean value)

Sets chart's data label leader line display behavior. Read/write .

Parameters:

value -

getCategoryNameVisible

public boolean getCategoryNameVisible()

Indicates chart's data label category name display behavior. Read/write .

Returns:

setCategoryNameVisible

public void setCategoryNameVisible(boolean value)

Sets chart's data label category name display behavior. Read/write .

Parameters:

value -

getLabelValueVisible

public boolean getLabelValueVisible()

Indicates chart's data label value display behavior. Read/write .

Returns:

setLabelValueVisible

public void setLabelValueVisible(boolean value)

Sets chart's data label value display behavior. Read/write .

Parameters:

value -

getPercentValueVisible

public boolean getPercentValueVisible()

Indicates chart's data label percentage value display behavior. Read/write .

Returns:

setPercentValueVisible

public void setPercentValueVisible(boolean value)

Sets chart's data label percentage value display behavior. Read/write .

Parameters:

value -

getSeriesNameVisible

public boolean getSeriesNameVisible()

Gets or sets a Boolean to indicate the series name display behavior for the data labels on a chart. Read/write .

Returns:

setSeriesNameVisible

public void setSeriesNameVisible(boolean value)

Gets or sets a Boolean to indicate the series name display behavior for the data labels on a chart. Read/write .

Parameters:

value -

getBubbleSizeVisible

public boolean getBubbleSizeVisible()

Indicates chart's data label bubble size value display behavior. Read/write .

Returns:

setBubbleSizeVisible

public void setBubbleSizeVisible(boolean value)

Sets chart's data label bubble size value display behavior. Read/write .

Parameters:

value -

getSeparator

public java.lang.String getSeparator()

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

Returns:

setSeparator

public void setSeparator(java.lang.String value)

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

Parameters:

value -

getCount

public int getCount()

Gets the number of elements actually contained in the collection. Read-only .

Returns:

getDataLabelShapeType

public DataLabelShapeType getDataLabelShapeType()

Gets or sets shape type of data labels. Read/write .

Returns:

setDataLabelShapeType

public void setDataLabelShapeType(DataLabelShapeType value)

Gets or sets shape type of data labels. Read/write .

Parameters:

value -

add

public ChartDataLabel add()

Adds the new DataLabel at the end of a collection.

Returns:

remove

public void remove(ChartDataLabel value)

Removes the first occurrence of a specific object from the collection.

Parameters:

value -

indexOf

public int indexOf(ChartDataLabel value)

Gets an index of the specified DataLabel in the collection.

Parameters:

value -

Returns:

get

public ChartDataLabel get(int index)

Gets the element at the specified index. Read-only .

Parameters:

index -

Returns:

getLeaderLines

public IChartGridLine getLeaderLines()

Gets LeaderLines of chart.

Returns: