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")
# adding a linear trendline
index = chart.getNSeries().get(0).getTrendLines().add(TrendlineType.LINEAR)
trendline = chart.getNSeries().get(0).getTrendLines().get(index)
# Setting the custom name of the trendline.
trendline.setName("Linear")
# Displaying the equation on chart
trendline.setDisplayEquation(True)
# Displaying the R-Squared value on chart
trendline.setDisplayRSquared(True)
# Saving the Excel file
workbook.save("Book1.xls")
| Property Getters/Setters Summary | ||
|---|---|---|
method | getBackward() | |
method | setBackward(value) | |
| Returns or sets the number of periods (or units on a scatter chart) that the trendline extends backward. The number of periods must be greater than or equal to zero. If the chart type is column ,the number of periods must be between 0 and 0.5 | ||
method | getBeginArrowLength() | |
method | setBeginArrowLength(value) | |
| Specifies the length of the arrowhead for the begin of a line. The value of the property is MsoArrowheadLength integer constant. | ||
method | getBeginArrowWidth() | |
method | setBeginArrowWidth(value) | |
| Specifies the width of the arrowhead for the begin of a line. The value of the property is MsoArrowheadWidth integer constant. | ||
method | getBeginType() | |
method | setBeginType(value) | |
| Specifies an arrowhead for the begin of a line. The value of the property is MsoArrowheadStyle integer constant. | ||
method | getCapType() | |
method | setCapType(value) | |
| Specifies the ending caps. The value of the property is LineCapType integer constant. | ||
method | getColor() | |
method | setColor(value) | |
|
Represents the |
||
method | getCompoundType() | |
method | setCompoundType(value) | |
| Specifies the compound line type The value of the property is MsoLineStyle integer constant. | ||
method | getDashType() | |
method | setDashType(value) | |
| Specifies the dash line type The value of the property is MsoLineDashStyle integer constant. | ||
method | getDataLabels() | |
Represents the DataLabels object for the specified series.
|
||
method | getDisplayEquation() | |
method | setDisplayEquation(value) | |
| Represents if the equation for the trendline is displayed on the chart (in the same data label as the R-squared value). Setting this property to True automatically turns on data labels. | ||
method | getDisplayRSquared() | |
method | setDisplayRSquared(value) | |
| Represents if the R-squared value of the trendline is displayed on the chart (in the same data label as the equation). Setting this property to True automatically turns on data labels. | ||
method | getEndArrowLength() | |
method | setEndArrowLength(value) | |
| Specifies the length of the arrowhead for the end of a line. The value of the property is MsoArrowheadLength integer constant. | ||
method | getEndArrowWidth() | |
method | setEndArrowWidth(value) | |
| Specifies the width of the arrowhead for the end of a line. The value of the property is MsoArrowheadWidth integer constant. | ||
method | getEndType() | |
method | setEndType(value) | |
| Specifies an arrowhead for the end of a line. The value of the property is MsoArrowheadStyle integer constant. | ||
method | getFormattingType() | |
method | setFormattingType(value) | |
| Gets or sets format type. The value of the property is ChartLineFormattingType integer constant. | ||
method | getForward() | |
method | setForward(value) | |
| Returns or sets the number of periods (or units on a scatter chart) that the trendline extends forward. The number of periods must be greater than or equal to zero. | ||
method | getGradientFill() | |
Represents gradient fill.
|
||
method | getIntercept() | |
method | setIntercept(value) | |
| Returns or sets the point where the trendline crosses the value axis. | ||
method | isAuto() | |
method | setAuto(value) | |
| Indicates whether this line style is auto assigned. | ||
method | isAutomaticColor() | |
Indicates whether the color of line is automatic assigned.
|
||
method | isNameAuto() | |
method | setNameAuto(value) | |
| Returns if Microsoft Excel automatically determines the name of the trendline. | ||
method | isVisible() | |
method | setVisible(value) | |
| Represents whether the line is visible. | ||
method | getJoinType() | |
method | setJoinType(value) | |
| Specifies the joining caps. The value of the property is LineJoinType integer constant. | ||
method | getLegendEntry() | |
Gets the legend entry according to this trendline
|
||
method | getName() | |
method | setName(value) | |
| Returns the name of the trendline. | ||
method | getOrder() | |
method | setOrder(value) | |
| Returns or sets the trendline order (an integer greater than 1) when the trendline type is Polynomial. The order must be between 2 and 6. | ||
method | getPeriod() | |
method | setPeriod(value) | |
| Returns or sets the period for the moving-average trendline. | ||
method | getStyle() | |
method | setStyle(value) | |
| Represents the style of the line. The value of the property is LineType integer constant. | ||
method | getThemeColor() | |
method | setThemeColor(value) | |
| Gets and sets the theme color. | ||
method | getTransparency() | |
method | setTransparency(value) | |
| Returns or sets the degree of transparency of the line as a value from 0.0 (opaque) through 1.0 (clear). | ||
method | getType() | |
Returns the trendline type.
The value of the property is TrendlineType integer constant. |
||
method | getWeight() | |
method | setWeight(value) | |
|
Gets or sets the |
||
method | getWeightPt() | |
method | setWeightPt(value) | |
| Gets or sets the weight of the line in unit of points. | ||
method | getWeightPx() | |
method | setWeightPx(value) | |
| Gets or sets the weight of the line in unit of pixels. | ||
| Method Summary | ||
|---|---|---|
method | isInterceptAuto() | |
Indicates whether Microsoft Workbook automatically determines the intercept of the trendline.
|
||
method | setInterceptAuto(isInterceptAuto) | |
Sets whether Microsoft Workbook automatically determines the intercept of the trendline.
|
||
boolean isNameAuto() / setNameAuto(value)
int getType()
String getName() / setName(value)
int getOrder() / setOrder(value)
int getPeriod() / setPeriod(value)
float getForward() / setForward(value)
float getBackward() / setBackward(value)
boolean getDisplayEquation() / setDisplayEquation(value)
boolean getDisplayRSquared() / setDisplayRSquared(value)
float getIntercept() / setIntercept(value)
DataLabels getDataLabels()
LegendEntry getLegendEntry()
int getCompoundType() / setCompoundType(value)
int getDashType() / setDashType(value)
int getCapType() / setCapType(value)
int getJoinType() / setJoinType(value)
int getBeginType() / setBeginType(value)
int getEndType() / setEndType(value)
int getBeginArrowLength() / setBeginArrowLength(value)
int getEndArrowLength() / setEndArrowLength(value)
int getBeginArrowWidth() / setBeginArrowWidth(value)
int getEndArrowWidth() / setEndArrowWidth(value)
ThemeColor getThemeColor() / setThemeColor(value)
Color getColor() / setColor(value)
float getTransparency() / setTransparency(value)
int getStyle() / setStyle(value)
int getWeight() / setWeight(value)
float getWeightPt() / setWeightPt(value)
float getWeightPx() / setWeightPx(value)
int getFormattingType() / setFormattingType(value)
boolean isAutomaticColor()
boolean isVisible() / setVisible(value)
boolean isAuto() / setAuto(value)
GradientFill getGradientFill()