com.aspose.slides
Class Legend

java.lang.Object
  extended by com.aspose.slides.Legend
All Implemented Interfaces:
IChartComponent, IFormattedTextContainer, ILayoutable, ILegend

public class Legend
extends java.lang.Object
implements ILegend

Represents chart's legend properties.


Method Summary
 float getBottom()
           
 IChart getChart()
           
 ILegendEntryCollection getEntries()
           Gets legend entries.
 IFormat getFormat()
           Returns the format of a legend.
 float getHeight()
           Returns or sets the height of a legend as a fraction of the height of the chart.
 boolean getOverlay()
           Determines whether other chart elements shall be allowed to overlap legend.
 int getPosition()
           Specifies the position of the legend on a chart.
 float getRight()
           
 IChartTextFormat getTextFormat()
           
 float getWidth()
           Returns or sets the width of a legend as a fraction of the width of the chart.
 float getX()
           Returns or sets the x coordinate of a legend as a fraction of the width of the chart.
 float getY()
           Returns or sets the y coordinate of a legend as a fraction of the height of the chart.
 void setHeight(float value)
           
 void setOverlay(boolean value)
           
 void setPosition(int value)
           
 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
 

Method Detail

getX

public float getX()

Returns or sets the x coordinate of a legend 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 legend 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 legend 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 legend 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

getOverlay

public boolean getOverlay()

Determines whether other chart elements shall be allowed to overlap legend. Read/write bool.

Specified by:
getOverlay in interface ILegend

setOverlay

public void setOverlay(boolean value)
Specified by:
setOverlay in interface ILegend

getTextFormat

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

getPosition

public int getPosition()

Specifies the position of the legend on a chart. Non-NaN values of X, Y, Width, Heigt properties override effect of this property. Read/write LegendPositionType.

Specified by:
getPosition in interface ILegend

setPosition

public void setPosition(int value)
Specified by:
setPosition in interface ILegend

getFormat

public IFormat getFormat()

Returns the format of a legend. Read-only Charts.Format.

Specified by:
getFormat in interface ILegend

getChart

public IChart getChart()
Specified by:
getChart in interface IChartComponent

getEntries

public ILegendEntryCollection getEntries()

Gets legend entries.

Specified by:
getEntries in interface ILegend