com.spire.xls.core.spreadsheet.charts
Class XlsChartLegend

java.lang.Object
  com.spire.xls.core.spreadsheet.XlsObject
      com.spire.xls.core.spreadsheet.charts.XlsChartLegend

All Implemented Interfaces:

IChartLegend

Direct Known Subclasses:

ChartLegend

public class XlsChartLegend
extends XlsObject
implements IChartLegend

Constructor Summary

XlsChartLegend(java.lang.Object parent)

Method Summary

void	clear() Clears chart legend.
XlsChartLegend	deepClone(java.lang.Object parent, java.util.HashMap dicFontIndexes, java.util.HashMap dicNewSheetNames) Clones current object.
void	delete() Deletes chart legend.
boolean	getAutoPosition() Automatic positioning .
boolean	getAutoPositionX() X positioning is automatic.
boolean	getAutoPositionY() Y positioning is automatic.
IChartFrameFormat	getFrameFormat()
int	getHeight() Y-size.
boolean	getIncludeInLayout() Show legend without overlapping.
boolean	getInnerLayoutTarget()
IChartLegendEntries	getLegendEntries() Represents legend entries collection.
LegendPositionType	getPosition() Legend position type.
IChartTextArea	getTextArea() Return text area of legend.
int	getWidth() X-size.
int	getX() X-position of upper-left corner.
int	getY() Y-position of upper-left corner.
boolean	hasDataTable() True if chart contains data table.
void	hasDataTable(boolean value) True if chart contains data table.
boolean	isHMode() false value Specifies that the Height shall be interpreted as the Bottom of the chart element..
void	isHMode(boolean value) false value Specifies that the Height shall be interpreted as the Bottom of the chart element..
boolean	isVerticalLegend() Indicates whether if vertical legend.
void	isVerticalLegend(boolean value) Indicates whether if vertical legend.
boolean	isWMode() false value Specifies that the Width shall be interpreted as the Right of the chart element..
void	isWMode(boolean value) false value Specifies that the Width shall be interpreted as the Right of the chart element..
boolean	isXMode() true value Specifies that the X shall be interpreted as the Left of the chart element..
void	isXMode(boolean value) true value Specifies that the X shall be interpreted as the Left of the chart element..
boolean	isYMode() true value Specifies that the Y shall be interpreted as the Top of the chart element..
void	isYMode(boolean value) true value Specifies that the Y shall be interpreted as the Top of the chart element..
void	setAutoPositionX(boolean value) X positioning is automatic.
void	setAutoPositionY(boolean value) Y positioning is automatic.
void	setHeight(int value) Y-size.
void	setIncludeInLayout(boolean value) Show legend without overlapping.
void	setInnerLayoutTarget(boolean value)
void	setPosition(LegendPositionType position) Sets legend position type.
void	setWidth(int value) X-size.
void	setX(int value) X-position of upper-left corner.
void	setY(int value) Y-position of upper-left corner.

Methods inherited from class com.spire.xls.core.spreadsheet.XlsObject

dispose

Constructor Detail

XlsChartLegend

public XlsChartLegend(java.lang.Object parent)

Method Detail

getAutoPosition

public boolean getAutoPosition()

Automatic positioning .

getTextArea

public IChartTextArea getTextArea()

Return text area of legend.

Specified by:

getTextArea in interface IChartLegend

getX

public int getX()

X-position of upper-left corner. 1/4000 of chart plot. IsXMode Shall set to True

Specified by:

getX in interface IChartLegend

setX

public void setX(int value)

X-position of upper-left corner. 1/4000 of chart plot. IsXMode Shall set to True

Specified by:

setX in interface IChartLegend

getY

public int getY()

Y-position of upper-left corner. 1/4000 of chart plot. IsYMode Shall set to True

Specified by:

getY in interface IChartLegend

setY

public void setY(int value)

Y-position of upper-left corner. 1/4000 of chart plot. IsYMode Shall set to True

Specified by:

setY in interface IChartLegend

getPosition

public LegendPositionType getPosition()

Legend position type.

Specified by:

getPosition in interface IChartLegend

setPosition

public void setPosition(LegendPositionType position)

Sets legend position type.

Specified by:

setPosition in interface IChartLegend

isVerticalLegend

public boolean isVerticalLegend()

Indicates whether if vertical legend.

Specified by:

isVerticalLegend in interface IChartLegend

isVerticalLegend

public void isVerticalLegend(boolean value)

Indicates whether if vertical legend.

Specified by:

isVerticalLegend in interface IChartLegend

getIncludeInLayout

public boolean getIncludeInLayout()

Show legend without overlapping. Default is True.

Specified by:

getIncludeInLayout in interface IChartLegend

setIncludeInLayout

public void setIncludeInLayout(boolean value)

Show legend without overlapping. Default is True.

Specified by:

setIncludeInLayout in interface IChartLegend

getInnerLayoutTarget

public boolean getInnerLayoutTarget()

Specified by:

getInnerLayoutTarget in interface IChartLegend

setInnerLayoutTarget

public void setInnerLayoutTarget(boolean value)

Specified by:

setInnerLayoutTarget in interface IChartLegend

isWMode

public boolean isWMode()

false value Specifies that the Width shall be interpreted as the Right of the chart element..

Specified by:

isWMode in interface IChartLegend

isWMode

public void isWMode(boolean value)

false value Specifies that the Width shall be interpreted as the Right of the chart element..

Specified by:

isWMode in interface IChartLegend

isHMode

public boolean isHMode()

false value Specifies that the Height shall be interpreted as the Bottom of the chart element..

Specified by:

isHMode in interface IChartLegend

isHMode

public void isHMode(boolean value)

false value Specifies that the Height shall be interpreted as the Bottom of the chart element..

Specified by:

isHMode in interface IChartLegend

isXMode

public boolean isXMode()

true value Specifies that the X shall be interpreted as the Left of the chart element..

Specified by:

isXMode in interface IChartLegend

isXMode

public void isXMode(boolean value)

true value Specifies that the X shall be interpreted as the Left of the chart element..

Specified by:

isXMode in interface IChartLegend

isYMode

public boolean isYMode()

true value Specifies that the Y shall be interpreted as the Top of the chart element..

Specified by:

isYMode in interface IChartLegend

isYMode

public void isYMode(boolean value)

true value Specifies that the Y shall be interpreted as the Top of the chart element..

Specified by:

isYMode in interface IChartLegend

getLegendEntries

public IChartLegendEntries getLegendEntries()

Represents legend entries collection. Read only.

Specified by:

getLegendEntries in interface IChartLegend

getWidth

public int getWidth()

X-size. 1/4000 of chart plot. IsWMode Shall set to True

Specified by:

getWidth in interface IChartLegend

setWidth

public void setWidth(int value)

X-size. 1/4000 of chart plot. IsWMode Shall set to True

Specified by:

setWidth in interface IChartLegend

getHeight

public int getHeight()

Y-size. 1/4000 of chart plot. IsHMode Shall set to True

Specified by:

getHeight in interface IChartLegend

setHeight

public void setHeight(int value)

Y-size. 1/4000 of chart plot. IsHMode Shall set to True

Specified by:

setHeight in interface IChartLegend

getAutoPositionX

public boolean getAutoPositionX()

X positioning is automatic.

Specified by:

getAutoPositionX in interface IChartLegend

setAutoPositionX

public void setAutoPositionX(boolean value)

X positioning is automatic.

Specified by:

setAutoPositionX in interface IChartLegend

getAutoPositionY

public boolean getAutoPositionY()

Y positioning is automatic.

Specified by:

getAutoPositionY in interface IChartLegend

setAutoPositionY

public void setAutoPositionY(boolean value)

Y positioning is automatic.

Specified by:

setAutoPositionY in interface IChartLegend

getFrameFormat

public IChartFrameFormat getFrameFormat()

hasDataTable

public boolean hasDataTable()

True if chart contains data table.

hasDataTable

public void hasDataTable(boolean value)

True if chart contains data table.

clear

public void clear()

Clears chart legend.

Specified by:

clear in interface IChartLegend

delete

public void delete()

Deletes chart legend.

Specified by:

delete in interface IChartLegend

deepClone

public XlsChartLegend deepClone(java.lang.Object parent,
                                java.util.HashMap dicFontIndexes,
                                java.util.HashMap dicNewSheetNames)

Clones current object.

Parameters:

parent - Parent object.

dicFontIndexes - Array with new font indexes.

Returns:

Returns cloned object.