Example:
# Instantiating a Workbook object
workbook = Workbook()
# Adding a new worksheet to the Excel object
sheetIndex = workbook.getWorksheets().add()
# Obtaining the reference of the newly added worksheet by passing its sheet index
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
chartIndex = worksheet.getCharts().add(ChartType.COLUMN, 5, 0, 15, 5)
# Accessing the instance of the newly added 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 = chart.getValueAxis().getDisplayUnitLabel()
# Setting the custom display unit label
displayUnitLabel.setText("100")
# Saving the Excel file
workbook.save("Book1.xls")
| Property Getters/Setters Summary | ||
|---|---|---|
method | getArea() | |
Gets the |
||
method | getAutoScaleFont() | |
method | setAutoScaleFont(value) | |
| True if the text in the object changes font size when the object size changes. The default value is True. | ||
method | getBackground() | |
method | setBackground(value) | |
| Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant. | ||
method | getBackgroundMode() | |
method | setBackgroundMode(value) | |
| Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant. | ||
method | getBorder() | |
Gets the |
||
method | getChart() | |
Gets the chart to which this object belongs.
|
||
method | getDefaultHeight() | |
Represents height of default position
|
||
method | getDefaultWidth() | |
Represents width of default position
|
||
method | getDefaultX() | |
Represents x of default position
|
||
method | getDefaultY() | |
Represents y of default position
|
||
method | getDirectionType() | |
method | setDirectionType(value) | |
| Gets and sets the direction of text. The value of the property is ChartTextDirectionType integer constant. | ||
method | getFont() | |
Gets a |
||
method | getHeight() | |
method | setHeight(value) | |
| Gets or sets the height of frame in units of 1/4000 of the chart area. | ||
method | isAutomaticSize() | |
method | setAutomaticSize(value) | |
| Indicates whether the chart frame is automatic sized. | ||
method | isAutoText() | |
method | setAutoText(value) | |
| Indicates the text is auto generated. | ||
method | isDefaultPosBeSet() | |
Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
|
||
method | isDeleted() | |
method | setDeleted(value) | |
| Indicates whether this data labels is deleted. | ||
method | isInnerMode() | |
method | 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. | ||
method | isResizeShapeToFitText() | |
method | 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. | ||
method | isTextWrapped() | |
method | setTextWrapped(value) | |
| Gets or sets a value indicating whether the text is wrapped. | ||
method | getLinkedSource() | |
method | setLinkedSource(value) | |
| Gets and sets a reference to the worksheet. | ||
method | getReadingOrder() | |
method | setReadingOrder(value) | |
| Represents text reading order. The value of the property is TextDirectionType integer constant. | ||
method | getRotationAngle() | |
method | setRotationAngle(value) | |
| Represents text rotation angle. | ||
method | getShadow() | |
method | setShadow(value) | |
| True if the frame has a shadow. | ||
method | getShapeProperties() | |
Gets the |
||
method | getText() | |
method | setText(value) | |
| Gets or sets the text of display unit label. | ||
method | getTextDirection() | |
method | setTextDirection(value) | |
| Represents text reading order. The value of the property is TextDirectionType integer constant. | ||
method | getTextFont() | |
Gets a |
||
method | getTextHorizontalAlignment() | |
method | setTextHorizontalAlignment(value) | |
| Gets and sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant. | ||
method | getTextVerticalAlignment() | |
method | setTextVerticalAlignment(value) | |
| Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant. | ||
method | getWidth() | |
method | setWidth(value) | |
| Gets or sets the width of frame in units of 1/4000 of the chart area. | ||
method | getX() | |
method | setX(value) | |
| Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area. | ||
method | getY() | |
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 | ||
|---|---|---|
method | characters(startIndex, length) | |
Returns a Characters object that represents a range of characters within the text.
|
||
method | setPositionAuto() | |
Set position of the frame to automatic
|
||
String getText() / setText(value)
boolean getAutoScaleFont() / setAutoScaleFont(value)
boolean isAutoText() / setAutoText(value)
boolean isDeleted() / setDeleted(value)
int getTextHorizontalAlignment() / setTextHorizontalAlignment(value)
int getTextVerticalAlignment() / setTextVerticalAlignment(value)
int getRotationAngle() / setRotationAngle(value)
String getLinkedSource() / setLinkedSource(value)
int getTextDirection() / setTextDirection(value)
int getReadingOrder() / setReadingOrder(value)
int getDirectionType() / setDirectionType(value)
boolean isTextWrapped() / setTextWrapped(value)
boolean isResizeShapeToFitText() / setResizeShapeToFitText(value)
boolean isInnerMode() / setInnerMode(value)
Font getTextFont()
int getBackgroundMode() / setBackgroundMode(value)
int getBackground() / setBackground(value)
boolean isAutomaticSize() / setAutomaticSize(value)
int getX() / setX(value)
int getY() / setY(value)
int getHeight() / setHeight(value)
int getWidth() / setWidth(value)
boolean getShadow() / setShadow(value)
ShapePropertyCollection getShapeProperties()
boolean isDefaultPosBeSet()
int getDefaultX()
int getDefaultY()
int getDefaultWidth()
int getDefaultHeight()
FontSetting characters(startIndex, length)
startIndex: int - The index of the start of the character.length: int - The number of characters.setPositionAuto()