com.aspose.cells
Class DisplayUnitLabel

java.lang.Object
  extended by ChartFrame
      extended by ChartTextFrame
          extended by com.aspose.cells.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()→ inherited from ChartFrame
           Gets the area.
booleangetAutoScaleFont()
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()
           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()→ inherited from ChartTextFrame
voidsetAutoText(boolean value)
           Indicates the text is auto generated.
booleanisDefaultPosBeSet()→ inherited from ChartFrame
           Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
booleanisDeleted()→ inherited from ChartTextFrame
voidsetDeleted(boolean value)
           Indicates whether this data lables is deleted.
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.
booleanisResizeShapeToFitText()→ inherited from ChartTextFrame
voidsetResizeShapeToFitText(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.
booleanisTextWrapped()→ inherited from ChartTextFrame
voidsetTextWrapped(boolean value)
           Gets or sets a value indicating whether the text is wrapped.
java.lang.StringgetLinkedSource()→ inherited from ChartTextFrame
voidsetLinkedSource(java.lang.String value)
           Gets and sets a reference to the worksheet.
intgetRotationAngle()→ inherited from ChartTextFrame
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()→ inherited from ChartTextFrame
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()→ inherited from ChartTextFrame
voidsetTextHorizontalAlignment(int value)
           Ges or sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.
intgetTextVerticalAlignment()→ inherited from ChartTextFrame
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()→ inherited from ChartFrame
voidsetX(int value)
           Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
intgetY()→ inherited from ChartFrame
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)→ inherited from ChartTextFrame
           Returns a Characters object that represents a range of characters within the text.
voidsetPositionAuto()→ inherited from ChartFrame
           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

→ inherited from ChartTextFrame
public boolean isAutoText() / public void setAutoText(boolean value)
Indicates the text is auto generated.

isDeleted/setDeleted

→ inherited from ChartTextFrame
public boolean isDeleted() / public void setDeleted(boolean value)
Indicates whether this data lables is deleted.

getTextHorizontalAlignment/setTextHorizontalAlignment

→ inherited from ChartTextFrame
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

→ inherited from ChartTextFrame
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

→ inherited from ChartTextFrame
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

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

getTextDirection/setTextDirection

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

isTextWrapped/setTextWrapped

→ inherited from ChartTextFrame
public boolean isTextWrapped() / public void setTextWrapped(boolean value)
Gets or sets a value indicating whether the text is wrapped.

isResizeShapeToFitText/setResizeShapeToFitText

→ inherited from ChartTextFrame
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

→ 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.

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.

getX/setX

→ inherited from ChartFrame
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

→ inherited from ChartFrame
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

→ 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

characters

→ inherited from ChartTextFrame
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

→ inherited from ChartFrame
public void setPositionAuto()
Set position of the frame to automatic

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