com.aspose.cells

Class DisplayUnitLabel

public class DisplayUnitLabel 
extends ChartTextFrame

Represents the display unit label.

Example:

//Instantiating a Workbook object
Workbook workbook = new Workbook();
//Adding a new worksheet to the Excel object
int sheetIndex = workbook.getWorksheets().add();
//Obtaining the reference of the newly added worksheet by passing its sheet index
Worksheet worksheet = workbook.getWorksheets().get(sheetIndex);
//Adding a sample value to "A1" cell
worksheet.getCells().get("A1").putValue(50);
//Adding a sample value to "A2" cell
worksheet.getCells().get("A2").putValue(100);
//Adding a sample value to "A3" cell
worksheet.getCells().get("A3").putValue(150);
//Adding a sample value to "A4" cell
worksheet.getCells().get("A4").putValue(200);
//Adding a sample value to "B1" cell
worksheet.getCells().get("B1").putValue(60);
//Adding a sample value to "B2" cell
worksheet.getCells().get("B2").putValue(32);
//Adding a sample value to "B3" cell
worksheet.getCells().get("B3").putValue(50);
//Adding a sample value to "B4" cell
worksheet.getCells().get("B4").putValue(40);
//Adding a sample value to "C1" cell as category data
worksheet.getCells().get("C1").putValue("Q1");
//Adding a sample value to "C2" cell as category data
worksheet.getCells().get("C2").putValue("Q2");
//Adding a sample value to "C3" cell as category data
worksheet.getCells().get("C3").putValue("Y1");
//Adding a sample value to "C4" cell as category data
worksheet.getCells().get("C4").putValue("Y2");
//Adding a chart to the worksheet
int chartIndex = worksheet.getCharts().add(ChartType.COLUMN, 5, 0, 15, 5);
//Accessing the instance of the newly added chart
Chart chart = worksheet.getCharts().get(chartIndex);
//Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B4"
chart.getNSeries().add("A1:B4", true);
//Setting the data source for the category data of NSeries
chart.getNSeries().setCategoryData("C1:C4");
//Setting the display unit of value(Y) axis.
chart.getValueAxis().setDisplayUnit(DisplayUnitType.HUNDREDS);
DisplayUnitLabel displayUnitLabel = chart.getValueAxis().getDisplayUnitLabel();
//Setting the custom display unit label
displayUnitLabel.setText("100");
//Saving the Excel file
workbook.save("C:\\book1.xls");

Property Getters/Setters Summary
AreagetArea()
Gets the area.
booleangetAutoScaleFont()
void
setAutoScaleFont(booleanvalue)
True if the text in the object changes font size when the object size changes. The default value is True.
intgetBackground()
void
setBackground(intvalue)
Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
intgetBackgroundMode()
void
Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
LinegetBorder()
Gets the Line.
ChartgetChart()
intgetDefaultHeight()
Represents height of default position
intgetDefaultWidth()
Represents width of default position
intgetDefaultX()
Represents x of default position
intgetDefaultY()
Represents y of default position
FontgetFont()
Gets a Font object of the specified ChartFrame object.
intgetHeight()
void
setHeight(intvalue)
Gets or sets the height of frame in units of 1/4000 of the chart area.
booleanisAutomaticSize()
void
setAutomaticSize(booleanvalue)
Indicates whether the chart frame is automatic sized.
booleanisAutoText()
void
setAutoText(booleanvalue)
Indicates the text is auto generated.
booleanisDefaultPosBeSet()
Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
booleanisDeleted()
void
setDeleted(booleanvalue)
Indicates whether this data lables is deleted.
booleanisInnerMode()
void
setInnerMode(booleanvalue)
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.
booleanisResizeShapeToFitText()
void
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.
booleanisTextWrapped()
void
setTextWrapped(booleanvalue)
Gets or sets a value indicating whether the text is wrapped.
java.lang.StringgetLinkedSource()
void
setLinkedSource(java.lang.Stringvalue)
Gets and sets a reference to the worksheet.
intgetRotationAngle()
void
Represents text rotation angle.
booleangetShadow()
void
setShadow(booleanvalue)
True if the frame has a shadow.
ShapePropertyCollectiongetShapeProperties()
Gets the ShapeProperties object.
java.lang.StringgetText()
void
setText(java.lang.Stringvalue)
Gets or sets the text of a frame's title.
intgetTextDirection()
void
Represents text reading order. The value of the property is TextDirectionType integer constant.
FontgetTextFont()
Gets a Font object of the specified ChartFrame object.
intgetTextHorizontalAlignment()
void
Ges or sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.
intgetTextVerticalAlignment()
void
Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant.
intgetWidth()
void
setWidth(intvalue)
Gets or sets the width of frame in units of 1/4000 of the chart area.
intgetX()
void
setX(intvalue)
Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
intgetY()
void
setY(intvalue)
Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
 
Method Summary
FontSettingcharacters(intstartIndex, intlength)
Returns a Characters object that represents a range of characters within the text.
voidsetPositionAuto()
Set position of the frame to automatic
 

    • Property Getters/Setters Detail

      • getText/setText

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

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

        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.
      • isAutoText/setAutoText

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

        public boolean isDeleted() / public void setDeleted(boolean value)
        
        Indicates whether this data lables is deleted.
      • 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.
      • getLinkedSource/setLinkedSource

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

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

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

        public boolean isResizeShapeToFitText() / public void setResizeShapeToFitText(boolean 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

        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

        public Chart getChart()
        
      • getBorder

        public Line getBorder()
        
        Gets the Line.
      • getArea

        public Area getArea()
        
        Gets the area.
      • getTextFont

        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.
      • getBackgroundMode/setBackgroundMode

        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

        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

        public boolean isAutomaticSize() / public void setAutomaticSize(boolean value)
        
        Indicates whether the chart frame is automatic sized.
      • getX/setX

        public int getX() / public void setX(int value)
        
        Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area. How to convert units of 1/4000 to pixels? X In Pixels = X * Chart.ChartObject.Width / 4000;
      • 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. How to convert units of 1/4000 to pixels? Y In Pixels = Y * Chart.ChartObject.Height / 4000;
      • getHeight/setHeight

        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

        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

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

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

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

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

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

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

      • characters

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

        public void setPositionAuto()
        Set position of the frame to automatic