com.aspose.slides
Class DataLabel

java.lang.Object
  extended by com.aspose.slides.DataLabel
All Implemented Interfaces:
IChartComponent, IDataLabel, IFormattedTextContainer, ILayoutable, IOverridableText

public class DataLabel
extends java.lang.Object
implements IDataLabel

Represents a series labels.


Constructor Summary
DataLabel(IChartSeries parent)
           Creates a new instance of DataLabel class.
 
Method Summary
 ITextFrame addTextFrameForOverriding(java.lang.String text)
           Initialize TextFrameForOverriding with the text in paramener "text".
 float getBottom()
           
 IChart getChart()
           Returns the parent chart.
 IDataLabelFormat getDataLabelFormat()
           
 float getHeight()
           Returns or sets the height of a title as a fraction of the height of the chart.
 boolean getLinkedSource()
          Deprecated. 
 float getRight()
           
 IChartTextFormat getTextFormat()
           
 TextFrame getTextFrame()
          Deprecated. 
 ITextFrame getTextFrameForOverriding()
           Can contain a rich formatted text.
 float getWidth()
           Returns or sets the width of a title as a fraction of the width of the chart.
 float getX()
           Returns or sets the x coordinate of a title as a fraction of the width of the chart.
 float getY()
           Returns or sets the y coordinate of a title as a fraction of the height of the chart.
 void hide()
           Make data label hidden by setting all Show*-flags (ShowValue, ...) to false state.
 boolean isVisible()
           False means that data label is not visible (and so all Show*-flags (ShowValue, ...) are false).
 void setHeight(float value)
           
 void setLinkedSource(boolean value)
          Deprecated. 
 void setTextFrame(TextFrame value)
          Deprecated. 
 void setWidth(float value)
           
 void setX(float value)
           
 void setY(float value)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DataLabel

public DataLabel(IChartSeries parent)

Creates a new instance of DataLabel class.

Parameters:
parent - Parent series.
Method Detail

getChart

public IChart getChart()

Returns the parent chart. Read-only IChart.

Specified by:
getChart in interface IChartComponent

isVisible

public boolean isVisible()

False means that data label is not visible (and so all Show*-flags (ShowValue, ...) are false).


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

Specified by:
isVisible in interface IDataLabel

hide

public void hide()

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


If data label is not visible (IsVisible is false) you can make data label visible with setting Show*-flags (ShowValue, ...) to true state.

Specified by:
hide in interface IDataLabel

addTextFrameForOverriding

public ITextFrame addTextFrameForOverriding(java.lang.String text)

Initialize TextFrameForOverriding with the text in paramener "text". If TextFrameForOverriding is already initialized then simply changes its text.

Specified by:
addTextFrameForOverriding in interface IOverridableText
Parameters:
text - Text for a new TextFrameForOverriding.

getTextFrameForOverriding

public ITextFrame getTextFrameForOverriding()

Can contain a rich formatted text. If this property is not null then this formatted text value overrides auto-generated text of data label. Auto-generated text of data label means text that is managed by ShowSeriesName, ShowValue, ... properties and is formatted with the TextFormatManager.TextFormat property.

Specified by:
getTextFrameForOverriding in interface IOverridableText

getTextFormat

public IChartTextFormat getTextFormat()
Specified by:
getTextFormat in interface IFormattedTextContainer

getX

public float getX()

Returns or sets the x coordinate of a title as a fraction of the width of the chart. Read/write float.

Specified by:
getX in interface ILayoutable

setX

public void setX(float value)
Specified by:
setX in interface ILayoutable

getY

public float getY()

Returns or sets the y coordinate of a title as a fraction of the height of the chart. Read/write float.

Specified by:
getY in interface ILayoutable

setY

public void setY(float value)
Specified by:
setY in interface ILayoutable

getWidth

public float getWidth()

Returns or sets the width of a title as a fraction of the width of the chart. Read/write float.

Specified by:
getWidth in interface ILayoutable

setWidth

public void setWidth(float value)
Specified by:
setWidth in interface ILayoutable

getHeight

public float getHeight()

Returns or sets the height of a title as a fraction of the height of the chart. Read/write float.

Specified by:
getHeight in interface ILayoutable

setHeight

public void setHeight(float value)
Specified by:
setHeight in interface ILayoutable

getRight

public float getRight()
Specified by:
getRight in interface ILayoutable

getBottom

public float getBottom()
Specified by:
getBottom in interface ILayoutable

getDataLabelFormat

public IDataLabelFormat getDataLabelFormat()
Specified by:
getDataLabelFormat in interface IDataLabel

getLinkedSource

@Deprecated
public boolean getLinkedSource()
Deprecated. 

Gets and sets a reference to the worksheet


setLinkedSource

@Deprecated
public void setLinkedSource(boolean value)
Deprecated. 


getTextFrame

@Deprecated
public TextFrame getTextFrame()
Deprecated. 

Returns a textframe of this data label.


setTextFrame

@Deprecated
public void setTextFrame(TextFrame value)
Deprecated.