public class Legend extends DomObject<Chart> implements ILegend
Represents chart's legend properties.
Modifier and Type | Method and Description |
---|---|
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.
|
getParent_Immediate
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
.
getX
in interface ILayoutable
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
.
setX
in interface ILayoutable
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
.
getY
in interface ILayoutable
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
.
setY
in interface ILayoutable
public final float getWidth()
Returns or sets the width of a legend as a fraction of the width of the chart.
Read/write float
.
getWidth
in interface ILayoutable
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
.
setWidth
in interface ILayoutable
public final float getHeight()
Returns or sets the height of a legend as a fraction of the height of the chart.
Read/write float
.
getHeight
in interface ILayoutable
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
.
setHeight
in interface ILayoutable
public final float getRight()
Right.
Read-only float
.
getRight
in interface ILayoutable
public final float getBottom()
Bottom.
Read-only float
.
getBottom
in interface ILayoutable
public final boolean getOverlay()
Determines whether other chart elements shall be allowed to overlap legend.
Read/write boolean
.
getOverlay
in interface ILegend
public final void setOverlay(boolean value)
Determines whether other chart elements shall be allowed to overlap legend.
Read/write boolean
.
setOverlay
in interface ILegend
public final IChartTextFormat getTextFormat()
Text format.
Read-only IChartTextFormat
.
getTextFormat
in interface IFormattedTextContainer
public final 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
.
getPosition
in interface ILegend
public final void setPosition(int value)
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
.
setPosition
in interface ILegend
public final IChart getChart()
Returns the chart.
Read-only IChart
.
getChart
in interface IChartComponent
public final ILegendEntryCollection getEntries()
Gets legend entries.
Read-only ILegendEntryCollection
.
getEntries
in interface ILegend
public final IBaseSlide getSlide()
Returns the parent slide of a FillFormat.
Read-only BaseSlide
.
getSlide
in interface ISlideComponent
public final IPresentation getPresentation()
Returns the parent presentation of a FillFormat.
Read-only IPresentation
.
getPresentation
in interface IPresentationComponent