XLSXChartAxis Class Reference

The XLSXChartAxis class represents the Excel chart axis. More...

Public Member Functions
String	getLastError ()
	Function to get the description of the last error that occurred. More...
boolean	setLabelAlign (String align)
	Set the alignment of the axis labels. More...
boolean	setLabelPosition (String position)
	Position the axis labels. More...
boolean	setName (String name)
	Set the name caption of the chart axis. More...
boolean	setNameRange (String sheetname, number row, number col)
	Set a chart axis name formula using row and column values. More...
boolean	setNumberFormat (String numFormat)
	Set the format of the numbers on the axis. More...
boolean	setReverse ()
	Reverse the order of the axis categories or values. More...

Detailed Description

The XLSXChartAxis class represents the Excel chart axis.

An XLSXChartAxis object isn't created directly. You can get it using the XLSXChart.getAxis(String axisType) function. It provides functions for configuring a chart axis.

Since

DOCUMENTS 5.0e

Example:

var writer = new XLSXWriter("c:\\tmp\\chartAxis.xlsx");
var worksheet1 = writer.addWorksheet("Worksheet1");

// Write some data to the worksheet.
writeWorksheetData(worksheet1);

// Create a chart object.
var chart = writer.addChart(writer.CHART_COLUMN);

// Configure the chart. In simplest case we just add some value data series. 
// The empty categories will default to 1 to 6 like in Excel.
var series1 = chart.addSeries("", "=Worksheet1!$A$2:$A$7");
var series2 = chart.addSeries("", "=Worksheet1!$B$2:$B$7");
var series3 = chart.addSeries("", "=Worksheet1!$C$2:$C$7");

// Get the X axis
var xAxis = chart.getAxis("x");
xAxis.setName("Months");
xAxis.setLabelPosition("high");
xAxis.setLabelAlign("right");

// Get the Y axis
var yAxis = chart.getAxis("y");
yAxis.setName("Earnings (Millions)");
yAxis.setNumberFormat("$#,##0.00");

chart.setTitle("A sample chart");
worksheet1.insertChart(8, 1, chart);

if (!writer.save())
    throw writer.getLastError();

function writeWorksheetData(worksheet)
{
    var data = [
        // Three columns of data.
        [1,   2,   3],
        [2,   4,   6],
        [3,   6,   9],
        [4,   8,  12],
        [5,  10,  15],
        [6,  12,  18]
    ];

    var row, col;
    for (row = 1; row < 7; row++)
        for (col = 0; col < 3; col++)
            worksheet.writeCell("number", row, col, data[row-1][col]);
}

Member Function Documentation

getLastError()

String XLSXChartAxis::getLastError

(

)

Function to get the description of the last error that occurred.

Returns

Text of the last error as String

Since

DOCUMENTS 5.0e

setLabelAlign()

boolean XLSXChartAxis::setLabelAlign

(

String

align

)

Set the alignment of the axis labels.

Position the category axis labels for the chart. The labels are the numbers, or strings or dates, on the axis that indicate the categories of the axis.

Parameters

align

The axis label alignment with the following available values: center left right

Returns

true if successful, false in case of any error

Note

This function is applicable to category axes only.

Since

DOCUMENTS 5.0e

Example:

xAxis.setLabelAlign("right");

setLabelPosition()

boolean XLSXChartAxis::setLabelPosition

(

String

position

)

Position the axis labels.

Position the axis labels for the chart. The labels are the numbers, or strings or dates, on the axis that indicate the categories or values of the axis.

Parameters

position

Option to position the axis labels. The following values are available: nextTo: Position the axis labels next to the axis. The default. high: Position the axis labels at the top of the chart, for horizontal axes, or to the right for vertical axes. low: Position the axis labels at the bottom of the chart, for horizontal axes, or to the left for vertical axes. none: Turn off the the axis labels.

Returns

true if successful, false in case of any error

Since

DOCUMENTS 5.0e

Example:

yAxis.setLabelPosition("high");

setName()

boolean XLSXChartAxis::setName

(

String

name

)

Set the name caption of the chart axis.

Parameters

name	String containing the name caption of the axis or a formula such as "=Worksheet1!$A$1" to point to a cell in the Excel file that contains the name.

Returns

true if successful, false in case of any error

Since

DOCUMENTS 5.0e

Example:

xAxis.setName("Months");
yAxis.setName("=Worksheet1!$A$1");

See also

XLSXChartAxis.setNameRange(String sheetname, number row, number col)

setNameRange()

boolean XLSXChartAxis::setNameRange	(	String	sheetname,
		number	row,
		number	col
	)

Set a chart axis name formula using row and column values.

This function can be used to set an axis name range and is an alternative to using XLSXChartAxis.setName(String name) and a string formula.

Parameters

sheetname	The name of the worksheet that contains the cell range.
row	The zero indexed row number of the range.
col	The zero indexed column number of the range.

Returns

true if successful, false in case of any error

Since

DOCUMENTS 5.0e

Example:

// Set the name formula programmatically
  yAxis.setNameRange("Worksheet1", 0, 0);

setNumberFormat()

boolean XLSXChartAxis::setNumberFormat

(

String

numFormat

)

Set the format of the numbers on the axis.

Parameters

numFormat

The number format string being similar to the parameter numFormat of the function XLSXFormat.setNumberFormat(String numFormat).

Returns

true if successful, false in case of any error

Since

DOCUMENTS 5.0e

Example:

yAxis.setNumberFormat("$#,##0.00");

setReverse()

boolean XLSXChartAxis::setReverse

(

)

Reverse the order of the axis categories or values.

Returns

true if successful, false in case of any error

Since

DOCUMENTS 5.0e