Interface IChartAxis

Namespace: Spire.Xls.Core

Assembly: Spire.XLS.dll

Represents an axis on the chart.

public interface IChartAxis

Properties

Alignment

Represents alignment for the tick label.

AxisTextDirectionType Alignment { get; set; }

Property Value

AxisTextDirectionType

AxisType

Returns type of the axis. Read-only. The following code illustrates how to access the AxisType property:

//Create worksheet
Workbook workbook = new Workbook();
Worksheet worksheet = workbook.Worksheets[0];

//Add data
worksheet.Range["A1"].Text = "Jan";
      worksheet.Range["B1"].Text = "Feb";
      worksheet.Range["C1"].Text = "Mar";
      worksheet.Range["A2"].Text = "10000";
      worksheet.Range["B2"].Text = "20000";
      worksheet.Range["C2"].Text = "30000";

//Create chart and set range
Chart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C2"];

//Set chart value axis
IChartAxis chartAxis = chart.PrimaryValueAxis;

//Get axis type
Console.WriteLine(chartAxis.AxisType);

//Save to file
workbook.SaveToFile("Chart.xlsx");

AxisType AxisType { get; }

Property Value

AxisType

Border

Represents chart border. Read only. The following code illustrates how to set color to IChart.PrimaryCategoryAxis's border using Border property:

//Create worksheet
Workbook workbook = new Workbook();
Worksheet worksheet = workbook.Worksheets[0];

//Add data
worksheet.Range["A1"].Text = "Jan";
      worksheet.Range["B1"].Text = "Feb";
      worksheet.Range["C1"].Text = "Mar";
      worksheet.Range["A2"].Text = "10";
      worksheet.Range["B2"].Text = "20";
      worksheet.Range["C2"].Text = "30";

//Create chart and set range
Chart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C2"];

//Set chart category axis
IChartAxis categoryAxis = chart.PrimaryCategoryAxis;

//Set border and color
IChartBorder border = categoryAxis.Border;
border.Color = Color.Red;

//Save to file
workbook.SaveToFile("Chart.xlsx");

ChartBorder Border { get; }

Property Value

ChartBorder

Chart3DOptions

Gets the three_ D.

IFormat3D Chart3DOptions { get; }

Property Value

IFormat3D: The three_ D.

Font

Returns font used for axis text displaying. Read-only. The following code illustrates how to set font color to the IChart.PrimaryCategoryAxis's category labels using Font property:

//Create worksheet
Workbook workbook = new Workbook();
Worksheet worksheet = workbook.Worksheets[0];

//Add data
worksheet.Range["A1"].Text = "Jan";
      worksheet.Range["B1"].Text = "Feb";
      worksheet.Range["C1"].Text = "Mar";
      worksheet.Range["A2"].Text = "10";
      worksheet.Range["B2"].Text = "20";
      worksheet.Range["C2"].Text = "30";

//Create chart and set range
Chart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C2"];

//Set chart axis
IChartAxis chartAxis =  chart.PrimaryCategoryAxis;

//Set font color
chartAxis.Font.Color = Color.Red;

//Save to file
workbook.SaveToFile("Chart.xlsx");

IFont Font { get; }

Property Value

IFont

HasMajorGridLines

Gets or sets if axis has major gridlines. The following code illustrates how to set visibility of MajorGridLines of IChart.PrimaryCategoryAxis:

//Create worksheet
Workbook workbook = new Workbook();
Worksheet worksheet = workbook.Worksheets[0];

//Add data
worksheet.Range["A1"].Text = "Jan";
      worksheet.Range["B1"].Text = "Feb";
      worksheet.Range["C1"].Text = "Mar";
      worksheet.Range["A2"].Text = "10";
      worksheet.Range["B2"].Text = "20";
      worksheet.Range["C2"].Text = "30";

//Create chart and set range
Chart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C2"];

//Set chart axis
IChartAxis chartAxis =  chart.PrimaryCategoryAxis;

//Set visibility
chartAxis.HasMajorGridLines = true;

//Save to file
workbook.SaveToFile("Chart.xlsx");

bool HasMajorGridLines { get; set; }

Property Value

bool

HasMinorGridLines

Gets or sets if axis has minor gridlines. The following code illustrates how to set visibility of MinorGridLines of IChart.PrimaryCategoryAxis:

//Create worksheet
Workbook workbook = new Workbook();
Worksheet worksheet = workbook.Worksheets[0];

//Add data
worksheet.Range["A1"].Text = "Jan";
      worksheet.Range["B1"].Text = "Feb";
      worksheet.Range["C1"].Text = "Mar";
      worksheet.Range["A2"].Text = "10";
      worksheet.Range["B2"].Text = "20";
      worksheet.Range["C2"].Text = "30";

//Create chart and set range
Chart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C2"];

//Set chart axis
IChartAxis chartAxis =  chart.PrimaryCategoryAxis;

//Set visibility
chartAxis.HasMinorGridLines = true;

//Save to file
workbook.SaveToFile("Chart.xlsx");

bool HasMinorGridLines { get; set; }

Property Value

bool

IsSourceLinked

bool IsSourceLinked { get; set; }

Property Value

bool

MajorGridLines

Represents major gridLines. Read-only. The following code illustrates how to access MajorGridLines of IChart.PrimaryCategoryAxis and set colors to it:

//Create worksheet
Workbook workbook = new Workbook();
Worksheet worksheet = workbook.Worksheets[0];

//Add data
worksheet.Range["A1"].Text = "Jan";
      worksheet.Range["B1"].Text = "Feb";
      worksheet.Range["C1"].Text = "Mar";
      worksheet.Range["A2"].Text = "10";
      worksheet.Range["B2"].Text = "20";
      worksheet.Range["C2"].Text = "30";

//Create chart and set range
Chart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C2"];

//Set chart axis
IChartAxis chartAxis =  chart.PrimaryCategoryAxis;

//Set visibility
chartAxis.HasMajorGridLines = true;

//Set grid lines
IChartGridLine gridLine = chartAxis.MajorGridLines;
gridLine.LineProperties.Color = Color.Red;

//Save to file
workbook.SaveToFile("Chart.xlsx");

IChartGridLine MajorGridLines { get; }

Property Value

IChartGridLine

MajorTickMark

Represents major tick marks. The following code illustrates how to set TickMarkType.TickMarkCross to MajorTickMark:

//Create worksheet
Workbook workbook = new Workbook();
Worksheet worksheet = workbook.Worksheets[0];

//Add data
worksheet.Range["A1"].Text = "Jan";
      worksheet.Range["B1"].Text = "Feb";
      worksheet.Range["C1"].Text = "Mar";
      worksheet.Range["A2"].Text = "10";
      worksheet.Range["B2"].Text = "20";
      worksheet.Range["C2"].Text = "30";

//Create chart and set range
Chart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C2"];

//Set chart category axis
IChartAxis categoryAxis = chart.PrimaryCategoryAxis;

//Set category minor tick type
categoryAxis.MajorTickMark = TickMarkType.TickMarkCross;

//Save to file
workbook.SaveToFile("Chart.xlsx");

TickMarkType MajorTickMark { get; set; }

Property Value

TickMarkType

MinorGridLines

Represents minor gridLines. Read-only. The following code illustrates how to access MinorGridLines of IChart.PrimaryCategoryAxis and set colors to it:

//Create worksheet
Workbook workbook = new Workbook();
Worksheet worksheet = workbook.Worksheets[0];

//Add data
worksheet.Range["A1"].Text = "Jan";
      worksheet.Range["B1"].Text = "Feb";
      worksheet.Range["C1"].Text = "Mar";
      worksheet.Range["A2"].Text = "10";
      worksheet.Range["B2"].Text = "20";
      worksheet.Range["C2"].Text = "30";

//Create chart and set range
Chart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C2"];

//Set chart axis
IChartAxis chartAxis =  chart.PrimaryCategoryAxis;

//Set visibility
chartAxis.HasMinorGridLines = true;

//Set grid lines
IChartGridLine gridLine = chartAxis.MinorGridLines;
gridLine.LineProperties.Color = Color.Red;

//Save to file
workbook.SaveToFile("Chart.xlsx");

IChartGridLine MinorGridLines { get; }

Property Value

IChartGridLine

MinorTickMark

Represents minor tick marks. The following code illustrates how to set TickMarkType.TickMarkCross to MinorTickMark:

//Create worksheet
Workbook workbook = new Workbook();
Worksheet worksheet = workbook.Worksheets[0];

//Add data
worksheet.Range["A1"].Text = "Jan";
      worksheet.Range["B1"].Text = "Feb";
      worksheet.Range["C1"].Text = "Mar";
      worksheet.Range["A2"].Text = "10";
      worksheet.Range["B2"].Text = "20";
      worksheet.Range["C2"].Text = "30";

//Create chart and set range
Chart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C2"];

//Set chart category axis
IChartAxis categoryAxis = chart.PrimaryCategoryAxis;

//Set category minor tick type
categoryAxis.MinorTickMark = TickMarkType.TickMarkCross;

//Save to file
workbook.SaveToFile("Chart.xlsx");

TickMarkType MinorTickMark { get; set; }

Property Value

TickMarkType

NumberFormat

Gets or sets number format string. The following code illustrates how to set currency format "\(#,##0_);(\)#,##0)" to NumberFormat to display value in the PrimaryValueAxis as currency:

//Create worksheet
Workbook workbook = new Workbook();
Worksheet worksheet = workbook.Worksheets[0];

//Add data
worksheet.Range["A1"].Text = "Jan";
      worksheet.Range["B1"].Text = "Feb";
      worksheet.Range["C1"].Text = "Mar";
      worksheet.Range["A2"].Text = "10000";
      worksheet.Range["B2"].Text = "20000";
      worksheet.Range["C2"].Text = "30000";

//Create chart and set range
Chart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C2"];

//Set chart value axis
IChartAxis chartAxis = chart.PrimaryValueAxis;

//Set number format
chartAxis.NumberFormat = @"$#,##0_);($#,##0)";

//Save to file
workbook.SaveToFile("Chart.xlsx");

string NumberFormat { get; set; }

Property Value

string

Shadow

Returns the Shadow properties.Read-only.

ChartShadow Shadow { get; }

Property Value

ChartShadow

TextDirection

axis's text direction

TextVerticalValue TextDirection { get; set; }

Property Value

TextVerticalValue

TextRotationAngle

Text rotation angle. Should be integer value between -90 and 90. The following code illustrates how to set TextRotationAngle for IChart.PrimaryCategoryAxis:

//Create worksheet
Workbook workbook = new Workbook();
Worksheet worksheet = workbook.Worksheets[0];

//Add data
worksheet.Range["A1"].Text = "Jan";
      worksheet.Range["B1"].Text = "Feb";
      worksheet.Range["C1"].Text = "Mar";
      worksheet.Range["A2"].Text = "10";
      worksheet.Range["B2"].Text = "20";
      worksheet.Range["C2"].Text = "30";

//Create chart and set range
Chart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C2"];

//Set chart category axis
IChartAxis chartAxis =  chart.PrimaryCategoryAxis;

//Set text rotation angle
chartAxis.TextRotationAngle = 90;

//Save to file
workbook.SaveToFile("Chart.xlsx");

int TextRotationAngle { get; set; }

Property Value

int

TickLabelPosition

Represents tick label position. The following code illustrates how to set TickLabelPositionType.TickLabelPositionHigh to TickLabelPosition property:

//Create worksheet
Workbook workbook = new Workbook();
Worksheet worksheet = workbook.Worksheets[0];

//Add data
worksheet.Range["A1"].Text = "Jan";
      worksheet.Range["B1"].Text = "Feb";
      worksheet.Range["C1"].Text = "Mar";
      worksheet.Range["A2"].Text = "10";
      worksheet.Range["B2"].Text = "20";
      worksheet.Range["C2"].Text = "30";

//Create chart and set range
Chart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C2"];

//Set chart category axis
IChartAxis categoryAxis = chart.PrimaryCategoryAxis;

//Set category tick labels position
categoryAxis.TickLabelPosition = TickLabelPositionType.TickLabelPositionHigh;

//Save to file
workbook.SaveToFile("Chart.xlsx");

TickLabelPositionType TickLabelPosition { get; set; }

Property Value

TickLabelPositionType

Title

Axis title. The following code illustrates how to set Title for the IChart.PrimaryCategoryAxis:

//Create worksheet
Workbook workbook = new Workbook();
Worksheet worksheet = workbook.Worksheets[0];

//Add data
worksheet.Range["A1"].Text = "Jan";
      worksheet.Range["B1"].Text = "Feb";
      worksheet.Range["C1"].Text = "Mar";
      worksheet.Range["A2"].Text = "10";
      worksheet.Range["B2"].Text = "20";
      worksheet.Range["C2"].Text = "30";

//Create chart and set range
Chart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C2"];

//Set chart category axis
IChartAxis categoryAxis = chart.PrimaryCategoryAxis;

//Set category title
categoryAxis.Title = "Categories";

//Save to file
workbook.SaveToFile("Chart.xlsx");

string Title { get; set; }

Property Value

string

TitleArea

Returns text area for the axis title. Read-only. The following code illustrates how to set foreground color to IChart.PrimaryCategoryAxis's title area using TitleArea property:

//Create worksheet
Workbook workbook = new Workbook();
Worksheet worksheet = workbook.Worksheets[0];

//Add data
worksheet.Range["A1"].Text = "Jan";
      worksheet.Range["B1"].Text = "Feb";
      worksheet.Range["C1"].Text = "Mar";
      worksheet.Range["A2"].Text = "10";
      worksheet.Range["B2"].Text = "20";
      worksheet.Range["C2"].Text = "30";

//Create chart and set range
Chart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C2"];

//Set chart category axis
IChartAxis categoryAxis = chart.PrimaryCategoryAxis;

//Set category title
categoryAxis.Title = "Categories";

//Set title area
IChartTextArea titleArea = categoryAxis.TitleArea;

//Set color
titleArea.FrameFormat.Fill.ForeKnownColor = ExcelColors.Red;

//Save to file
workbook.SaveToFile("Chart.xlsx");

IChartTextArea TitleArea { get; }

Property Value

IChartTextArea

Visible

Indicates is axis is visible. The following code illustrates how to set visibility of IChart.PrimaryCategoryAxis:

//Create worksheet
Workbook workbook = new Workbook();
Worksheet worksheet = workbook.Worksheets[0];

//Add data
worksheet.Range["A1"].Text = "Jan";
      worksheet.Range["B1"].Text = "Feb";
      worksheet.Range["C1"].Text = "Mar";
      worksheet.Range["A2"].Text = "10";
      worksheet.Range["B2"].Text = "20";
      worksheet.Range["C2"].Text = "30";

//Create chart and set range
Chart chart = worksheet.Charts.Add();
chart.DataRange = worksheet.Range["A1:C2"];

//Set chart axis
IChartAxis chartAxis =  chart.PrimaryCategoryAxis;

//Set visibility
chartAxis.Visible = false;

//Save to file
workbook.SaveToFile("Chart.xlsx");

bool Visible { get; set; }

Property Value

bool

Table of Contents

Interface IChartAxis

Properties

Alignment

Property Value

AxisType

Property Value

Border

Property Value

Chart3DOptions

Property Value

Font

Property Value

HasMajorGridLines

Property Value

HasMinorGridLines

Property Value

IsSourceLinked

Property Value

MajorGridLines

Property Value

MajorTickMark

Property Value

MinorGridLines

Property Value

MinorTickMark

Property Value

NumberFormat

Property Value

Shadow

Property Value

TextDirection

Property Value

TextRotationAngle

Property Value

TickLabelPosition

Property Value

Title

Property Value

TitleArea

Property Value

Visible

Property Value