asposecells.api

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

Example:

excel = Workbook()
charts = excel.getWorksheets().get(0).getCharts()
# Create a chart
chart = charts.get(charts.add(ChartType.COLUMN, 1, 1, 10, 10))

# 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
methodgetArea()
Gets the area.
methodgetAutoScaleFont()
method
           True if the text in the object changes font size when the object size changes. The default value is True.
methodgetBackground()
method
           Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
methodgetBackgroundMode()
method
           Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
methodgetBorder()
Gets the Line.
methodgetChart()
methodgetDefaultHeight()
Represents height of default position
methodgetDefaultWidth()
Represents width of default position
methodgetDefaultX()
Represents x of default position
methodgetDefaultY()
Represents y of default position
methodgetFont()
Gets a Font object of the specified ChartFrame object.
methodgetHeight()
method
setHeight(value)
           Gets or sets the height of frame in units of 1/4000 of the chart area.
methodisAutomaticSize()
method
           Indicates whether the chart frame is automatic sized.
methodisAutoText()
method
           Indicates the text is auto generated.
methodisDefaultPosBeSet()
Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
methodisDeleted()
method
setDeleted(value)
           Indicates whether this data lables is deleted.
methodisInnerMode()
method
           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.
methodisResizeShapeToFitText()
method
           Gets or sets whether a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text within a shape is scaled in order to contain all the text inside.
methodisTextWrapped()
method
           Gets or sets a value indicating whether the text is wrapped.
methodisVisible()
method
setVisible(value)
           Represents whether the title is visible.
methodgetLinkedSource()
method
           Gets and sets a reference to the worksheet.
methodgetOverLay()
method
setOverLay(value)
           Represents overlay centered title on chart without resising chart.
methodgetRotationAngle()
method
           Represents text rotation angle.
methodgetShadow()
method
setShadow(value)
           True if the frame has a shadow.
methodgetShapeProperties()
Gets the ShapeProperties object.
methodgetText()
method
setText(value)
           Gets or sets the text of a frame's title.
methodgetTextDirection()
method
           Represents text reading order. The value of the property is TextDirectionType integer constant.
methodgetTextFont()
Gets a Font object of the specified ChartFrame object.
methodgetTextHorizontalAlignment()
method
           Ges or sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.
methodgetTextVerticalAlignment()
method
           Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant.
methodgetWidth()
method
setWidth(value)
           Gets or sets the width of frame in units of 1/4000 of the chart area.
methodgetX()
method
setX(value)
           Gets or sets the x coordinate of the upper left corne in units of 1/4000 of the chart area.
methodgetY()
method
setY(value)
           Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
 
Method Summary
methodcharacters()
Gets rich text formatting of this Title.
methodcharacters(startIndex, length)
Returns a Characters object that represents a range of characters within the text.
methodgetCharacters()
Gets rich text formatting of this Title.
methodsetPositionAuto()
Set position of the frame to automatic
 

    • Property Getters/Setters Detail

      • isVisible/setVisible : boolean 

        boolean isVisible() / setVisible(value)
        
        Represents whether the title is visible.
      • getX/setX : int 

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

        int getY() / setY(value)
        
        Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
      • getOverLay/setOverLay : boolean 

        boolean getOverLay() / setOverLay(value)
        
        Represents overlay centered title on chart without resising chart.
      • isAutoText/setAutoText : boolean 

        boolean isAutoText() / setAutoText(value)
        
        Indicates the text is auto generated.
      • isDeleted/setDeleted : boolean 

        boolean isDeleted() / setDeleted(value)
        
        Indicates whether this data lables is deleted.
      • getTextHorizontalAlignment/setTextHorizontalAlignment : int 

        int getTextHorizontalAlignment() / setTextHorizontalAlignment(value)
        
        Ges or sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.
      • getTextVerticalAlignment/setTextVerticalAlignment : int 

        int getTextVerticalAlignment() / setTextVerticalAlignment(value)
        
        Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant.
      • getRotationAngle/setRotationAngle : int 

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

        255: Top to Bottom.

        -90: Downward.

        90: Upward.
      • getText/setText : String 

        String getText() / setText(value)
        
        Gets or sets the text of a frame's title.
      • getLinkedSource/setLinkedSource : String 

        String getLinkedSource() / setLinkedSource(value)
        
        Gets and sets a reference to the worksheet.
      • getTextDirection/setTextDirection : int 

        int getTextDirection() / setTextDirection(value)
        
        Represents text reading order. The value of the property is TextDirectionType integer constant.
      • isTextWrapped/setTextWrapped : boolean 

        boolean isTextWrapped() / setTextWrapped(value)
        
        Gets or sets a value indicating whether the text is wrapped.
      • isResizeShapeToFitText/setResizeShapeToFitText : boolean 

        boolean isResizeShapeToFitText() / setResizeShapeToFitText(value)
        
        Gets or sets whether a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text within a shape is scaled in order to contain all the text inside.
      • isInnerMode/setInnerMode : boolean 

        boolean isInnerMode() / setInnerMode(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.
      • getTextFont : Font 

        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 : Font 

        Font getFont()
        
        Gets a Font object of the specified ChartFrame object.
      • getAutoScaleFont/setAutoScaleFont : boolean 

        boolean getAutoScaleFont() / setAutoScaleFont(value)
        
        True if the text in the object changes font size when the object size changes. The default value is True.
      • getBackgroundMode/setBackgroundMode : int 

        int getBackgroundMode() / setBackgroundMode(value)
        
        Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
      • getBackground/setBackground : int 

        int getBackground() / setBackground(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 : boolean 

        boolean isAutomaticSize() / setAutomaticSize(value)
        
        Indicates whether the chart frame is automatic sized.
      • getHeight/setHeight : int 

        int getHeight() / setHeight(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 : int 

        int getWidth() / setWidth(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 : boolean 

        boolean getShadow() / setShadow(value)
        
        True if the frame has a shadow.
      • isDefaultPosBeSet : boolean 

        boolean isDefaultPosBeSet()
        
        Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
      • getDefaultX : int 

        int getDefaultX()
        
        Represents x of default position
      • getDefaultY : int 

        int getDefaultY()
        
        Represents y of default position
      • getDefaultWidth : int 

        int getDefaultWidth()
        
        Represents width of default position
      • getDefaultHeight : int 

        int getDefaultHeight()
        
        Represents height of default position
    • Method Detail

      • getCharacters

        FontSetting[] getCharacters()
        Gets rich text formatting of this Title. NOTE: This member is now obsolete. Instead, please use Title.Characters() method. This property will be removed 12 months later since November 2016. Aspose apologizes for any inconvenience you may have experienced.
        Returns:
        returns FontSetting array
      • characters

        FontSetting[] characters()
        Gets rich text formatting of this Title.
        Returns:
        returns FontSetting array
      • characters

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

         setPositionAuto()
        Set position of the frame to automatic