com.aspose.cells
Class Title

java.lang.Object
  extended by ChartFrame
      extended by com.aspose.cells.Title

public class Title 
extends ChartFrame

Encapsulates the object that represents the title of chart or axis.

Example:

//Setting the title of a chart
chart.getTitle().setText("Title");
//Setting the font color of the chart title to blue
chart.getTitle().getTextFont().setColor(Color.getBlue());
//Setting the title of category axis of the chart
chart.getCategoryAxis().getTitle().setText("Category");
//Setting the title of value axis of the chart
chart.getValueAxis().getTitle().setText("Value");

Property Getters/Setters Summary
AreagetArea()→ inherited from ChartFrame
           Gets the area.
booleangetAutoScaleFont()→ inherited from ChartFrame
voidsetAutoScaleFont(boolean value)
           True if the text in the object changes font size when the object size changes. The default value is True.
intgetBackground()→ inherited from ChartFrame
voidsetBackground(int value)
           Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
intgetBackgroundMode()→ inherited from ChartFrame
voidsetBackgroundMode(int value)
           Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
LinegetBorder()→ inherited from ChartFrame
           Gets the Line.
ChartgetChart()→ inherited from ChartFrame
          
intgetDefaultHeight()→ inherited from ChartFrame
           Represents height of default position
intgetDefaultWidth()→ inherited from ChartFrame
           Represents width of default position
intgetDefaultX()→ inherited from ChartFrame
           Represents x of default position
intgetDefaultY()→ inherited from ChartFrame
           Represents y of default position
FontgetFont()→ inherited from ChartFrame
           Gets a Font object of the specified ChartFrame object.
intgetHeight()→ inherited from ChartFrame
voidsetHeight(int value)
           Gets or sets the height of frame in units of 1/4000 of the chart area.
booleanisAutomaticSize()→ inherited from ChartFrame
voidsetAutomaticSize(boolean value)
           Indicates whether the chart frame is automatic sized.
booleanisAutoText()
voidsetAutoText(boolean value)
          
booleanisDefaultPosBeSet()→ inherited from ChartFrame
           Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
booleanisInnerMode()→ inherited from ChartFrame
voidsetInnerMode(boolean value)
           Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
booleanisVisible()
voidsetVisible(boolean value)
           Represents whether the title is visible.
java.lang.StringgetLinkedSource()
voidsetLinkedSource(java.lang.String value)
           Gets and sets a reference to the worksheet.
booleangetOverLay()
voidsetOverLay(boolean value)
          
intgetRotation()
voidsetRotation(int value)
           Represents text rotation angle.
intgetRotationAngle()
voidsetRotationAngle(int value)
           Represents text rotation angle.
booleangetShadow()→ inherited from ChartFrame
voidsetShadow(boolean value)
           True if the frame has a shadow.
ShapePropertyCollectiongetShapeProperties()→ inherited from ChartFrame
           Gets the ShapeProperties object.
java.lang.StringgetText()
voidsetText(java.lang.String value)
           Gets or sets the text of a frame's title.
intgetTextDirection()
voidsetTextDirection(int value)
           Represents text reading order. The value of the property is TextDirectionType integer constant.
FontgetTextFont()→ inherited from ChartFrame
           Gets a Font object of the specified ChartFrame object.
intgetTextHorizontalAlignment()
voidsetTextHorizontalAlignment(int value)
           Ges or sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.
intgetTextVerticalAlignment()
voidsetTextVerticalAlignment(int value)
           Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant.
intgetWidth()→ inherited from ChartFrame
voidsetWidth(int value)
           Gets or sets the width of frame in units of 1/4000 of the chart area.
intgetX()
voidsetX(int value)
           Gets or sets the x coordinate of the upper left corne in units of 1/4000 of the chart area.
intgetY()
voidsetY(int value)
           Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
 
Method Summary
FontSettingcharacters(int startIndex, int length)
           Returns a Characters object that represents a range of characters within the title.
com.aspose.cells.FontSetting[]getCharacters()
           Gets rich text formatting of this Title.
voidremoveCharacters()
           Remove all Character sets.
 

Property Getters/Setters Detail

getTextHorizontalAlignment/setTextHorizontalAlignment

public int getTextHorizontalAlignment() / public void setTextHorizontalAlignment(int value)
Ges or sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.

getTextVerticalAlignment/setTextVerticalAlignment

public int getTextVerticalAlignment() / public void setTextVerticalAlignment(int value)
Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant.

getRotationAngle/setRotationAngle

public int getRotationAngle() / public void setRotationAngle(int value)
Represents text rotation angle.
0: Not rotated.

255: Top to Bottom.

-90: Downward.

90: Upward.

getRotation/setRotation

public int getRotation() / public void setRotation(int value)
Represents text rotation angle.
0: Not rotated.

255: Top to Bottom.

-90: Downward.

90: Upward.
NOTE: This member is now obsolete. Instead, please use Title.RotationAngle property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.

getText/setText

public java.lang.String getText() / public void setText(java.lang.String value)
Gets or sets the text of a frame's title.

isVisible/setVisible

public boolean isVisible() / public void setVisible(boolean value)
Represents whether the title is visible.

isAutoText/setAutoText

public boolean isAutoText() / public void setAutoText(boolean value)

getX/setX

public int getX() / public void setX(int value)
Gets or sets the x coordinate of the upper left corne in units of 1/4000 of the chart area.

getY/setY

public int getY() / public void setY(int value)
Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.

getTextDirection/setTextDirection

public int getTextDirection() / public void setTextDirection(int value)
Represents text reading order. The value of the property is TextDirectionType integer constant.

getLinkedSource/setLinkedSource

public java.lang.String getLinkedSource() / public void setLinkedSource(java.lang.String value)
Gets and sets a reference to the worksheet.

getOverLay/setOverLay

public boolean getOverLay() / public void setOverLay(boolean value)

isInnerMode/setInnerMode

→ inherited from ChartFrame
public boolean isInnerMode() / public void setInnerMode(boolean value)
Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels. Only for Xlsx file.

getChart

→ inherited from ChartFrame
public Chart getChart()

getBorder

→ inherited from ChartFrame
public Line getBorder()
Gets the Line.

getArea

→ inherited from ChartFrame
public Area getArea()
Gets the area.

getTextFont

→ inherited from ChartFrame
public Font getTextFont()
Gets a Font object of the specified ChartFrame object. NOTE: This member is now obsolete. Instead, please use ChartFrame.Font property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

getFont

→ inherited from ChartFrame
public Font getFont()
Gets a Font object of the specified ChartFrame object.

getAutoScaleFont/setAutoScaleFont

→ inherited from ChartFrame
public boolean getAutoScaleFont() / public void setAutoScaleFont(boolean value)
True if the text in the object changes font size when the object size changes. The default value is True.

getBackgroundMode/setBackgroundMode

→ inherited from ChartFrame
public int getBackgroundMode() / public void setBackgroundMode(int value)
Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.

getBackground/setBackground

→ inherited from ChartFrame
public int getBackground() / public void setBackground(int value)
Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead, please use ChartFrame.BackgroundMode property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

isAutomaticSize/setAutomaticSize

→ inherited from ChartFrame
public boolean isAutomaticSize() / public void setAutomaticSize(boolean value)
Indicates whether the chart frame is automatic sized.

getHeight/setHeight

→ inherited from ChartFrame
public int getHeight() / public void setHeight(int value)
Gets or sets the height of frame in units of 1/4000 of the chart area. How to convert units of 1/4000 to pixels? Height In Pixels = Y * Chart.ChartObject.Height / 4000;

getWidth/setWidth

→ inherited from ChartFrame
public int getWidth() / public void setWidth(int value)
Gets or sets the width of frame in units of 1/4000 of the chart area. How to convert units of 1/4000 to pixels? Width In Pixels = Width * Chart.ChartObject.Height / 4000;

getShadow/setShadow

→ inherited from ChartFrame
public boolean getShadow() / public void setShadow(boolean value)
True if the frame has a shadow.

getShapeProperties

→ inherited from ChartFrame
public ShapePropertyCollection getShapeProperties()
Gets the ShapeProperties object.

isDefaultPosBeSet

→ inherited from ChartFrame
public boolean isDefaultPosBeSet()
Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.

getDefaultX

→ inherited from ChartFrame
public int getDefaultX()
Represents x of default position

getDefaultY

→ inherited from ChartFrame
public int getDefaultY()
Represents y of default position

getDefaultWidth

→ inherited from ChartFrame
public int getDefaultWidth()
Represents width of default position

getDefaultHeight

→ inherited from ChartFrame
public int getDefaultHeight()
Represents height of default position

Method Detail

removeCharacters

public void removeCharacters()
Remove all Character sets.

characters

public FontSetting characters(int startIndex, int length)
Returns a Characters object that represents a range of characters within the title.
Parameters:
startIndex - The index of the start of the character.
length - The number of characters.
Returns:
Characters object.

getCharacters

public com.aspose.cells.FontSetting[] getCharacters()
Gets rich text formatting of this Title.
Returns:
returns FontSetting array

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.