com.aspose.slides

Class Legend

java.lang.Object

com.aspose.slides.DomObject<Chart>

com.aspose.slides.Legend

All Implemented Interfaces:

IActualLayout, IChartComponent, IFormattedTextContainer, ILayoutable, ILegend, IPresentationComponent, ISlideComponent

public class Legend
extends DomObject<Chart>
implements ILegend

Represents chart's legend properties.

Method Summary

Modifier and Type	Method and Description
float	getActualHeight() Specifies actual height of the chart element.
float	getActualWidth() Specifies actual width of the chart element.
float	getActualX() Specifies actual x location (left) of the chart element relative to the left top corner of the chart.
float	getActualY() Specifies actual top of the chart element relative to the left top corner of the chart.
float	getBottom() Bottom.
IChart	getChart() Returns the chart.
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.
IPresentation	getPresentation() Returns the parent presentation of a FillFormat.
float	getRight() Right.
IBaseSlide	getSlide() Returns the parent slide of a FillFormat.
IChartTextFormat	getTextFormat() Text format.
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) Returns or sets the height of a legend as a fraction of the height of the chart.
void	setOverlay(boolean value) Determines whether other chart elements shall be allowed to overlap legend.
void	setPosition(int value) Specifies the position of the legend on a chart.
void	setWidth(float value) Returns or sets the width of a legend as a fraction of the width of the chart.
void	setX(float value) Returns or sets the x coordinate of a legend as a fraction of the width of the chart.
void	setY(float value) Returns or sets the y coordinate of a legend as a fraction of the height of the chart.

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

Method Detail

getX

public final 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 final void setX(float value)

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

Specified by:

setX in interface ILayoutable

getY

public final 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 final void setY(float value)

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

Specified by:

setY in interface ILayoutable

getWidth

public final 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 final void setWidth(float value)

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

Specified by:

setWidth in interface ILayoutable

getHeight

public final 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 final void setHeight(float value)

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

Specified by:

setHeight in interface ILayoutable

getRight

public final float getRight()

Right. Read-only float.

Specified by:

getRight in interface ILayoutable

getBottom

public final float getBottom()

Bottom. Read-only float.

Specified by:

getBottom in interface ILayoutable

getOverlay

public final boolean getOverlay()

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

Specified by:

getOverlay in interface ILegend

setOverlay

public final void setOverlay(boolean value)

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

Specified by:

setOverlay in interface ILegend

getTextFormat

public final IChartTextFormat getTextFormat()

Text format. Read-only IChartTextFormat.

Specified by:

getTextFormat in interface IFormattedTextContainer

getPosition

public final int getPosition()

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

Specified by:

getPosition in interface ILegend

setPosition

public final void setPosition(int value)

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

Specified by:

setPosition in interface ILegend

getFormat

public final IFormat getFormat()

Returns the format of a legend. Read-only IFormat.

Specified by:

getFormat in interface ILegend

getChart

public final IChart getChart()

Returns the chart. Read-only IChart.

Specified by:

getChart in interface IChartComponent

getEntries

public final ILegendEntryCollection getEntries()

Gets legend entries. Read-only ILegendEntryCollection.

Specified by:

getEntries in interface ILegend

getActualX

public final float getActualX()

Specifies actual x location (left) of the chart element relative to the left top corner of the chart. Call method IChart.validateChartLayout() before to get actual values. Read float.

Specified by:

getActualX in interface IActualLayout

getActualY

public final float getActualY()

Specifies actual top of the chart element relative to the left top corner of the chart. Call method IChart.validateChartLayout() before to get actual values. Read float.

Specified by:

getActualY in interface IActualLayout

getActualWidth

public final float getActualWidth()

Specifies actual width of the chart element. Call method IChart.validateChartLayout() before to get actual values. Read float.

Specified by:

getActualWidth in interface IActualLayout

getActualHeight

public final float getActualHeight()

Specifies actual height of the chart element. Call method IChart.validateChartLayout() before to get actual values. Read float.

Specified by:

getActualHeight in interface IActualLayout

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