DisplayUnitOptions.UnitType Property

Get or sets the display units for the value axis.

Namespace: DevExpress.Spreadsheet.Charts

Assembly: DevExpress.Spreadsheet.v19.1.Core.dll

Declaration

C#

DisplayUnitType UnitType { get; set; }

VB.NET

Property UnitType As DisplayUnitType

Property Value

Type	Description
DisplayUnitType	A DisplayUnitType enumeration value specifying the type of display unit scaling applied to the value axis.

Available values:

Show 11 items

Name	Description
None	Specifies that values on the value axis should be displayed by default based on chart data.
Billions	Specifies that values on the value axis should be divided by 1,000,000,000.
HundredMillions	Specifies that values on the value axis should be divided by 100,000,000.
Hundreds	Specifies that values on the value axis should be divided by 100.
HundredThousands	Specifies that values on the value axis should be divided by 100,000.
Millions	Specifies that values on the value axis should be divided by 1,000,000.
TenMillions	Specifies that values on the value axis should be divided by 10,000,000.
TenThousands	Specifies that values on the value axis should be divided by 10,000.
Thousands	Specifies that values on the value axis should be divided by 1,000.
Trillions	Specifies that values on the value axis should be divided by 1,000,000,000,000.
Custom	Specifies that custom display units defined by the DisplayUnitOptions.CustomUnit property should be used to display values on the value axis.

Property Paths

You can access this nested property as listed below:

Object Type	Path to UnitType
Axis	.DisplayUnits.UnitType

Remarks

Use the UnitType property to make the value axis labels easier to read when you plot large numbers on the chart. For example, if the value axis stretches from 10,000 to 100,000, set the UnitType property to DisplayUnitType.Thousands to change the scaling value and display numbers on the value axis as 10 to 100. To show the display unit label, set the DisplayUnitOptions.ShowLabel property to true.

The following images demonstrate how the UnitType property works.

UnitType = DisplayUnitType.None	UnitType = DisplayUnitType.Thousands

Example

The example below demonstrates how to create a clustered column chart and specify the display units for the value axis by utilizing the Axis.DisplayUnits property. This property provides access to the DisplayUnitOptions object containing display unit settings. Set the DisplayUnitOptions.UnitType property to DisplayUnitType.Thousands to divide values on the axis by 1,000. To show the display unit label, set the DisplayUnitOptions.ShowLabel property to true.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/spreadsheet-document-server-chart-api-t132724

AxesActions1.cs

Worksheet worksheet = workbook.Worksheets["chartTask7"];
workbook.Worksheets.ActiveWorksheet = worksheet;

// Create a chart and specify its location.
Chart chart = worksheet.Charts.Add(ChartType.ColumnClustered, worksheet["B2:C8"]);
chart.TopLeftCell = worksheet.Cells["F2"];
chart.BottomRightCell = worksheet.Cells["N17"];

// Change the scale of the value axis.
AxisCollection axisCollection = chart.PrimaryAxes;
Axis valueAxis = axisCollection[1];
valueAxis.Scaling.AutoMax = false;
valueAxis.Scaling.Max = 8000000;
valueAxis.Scaling.AutoMin = false;
valueAxis.Scaling.Min = 0;

// Specify display units for the value axis.
valueAxis.DisplayUnits.UnitType = DisplayUnitType.Thousands;
valueAxis.DisplayUnits.ShowLabel = true;

// Set the chart style.
chart.Style = ChartStyle.ColorBevel;
chart.Views[0].VaryColors = true;

// Hide the legend.
chart.Legend.Visible = false;

AxesActions1.vb

Dim worksheet As Worksheet = workbook.Worksheets("chartTask7")
workbook.Worksheets.ActiveWorksheet = worksheet

' Create a chart and specify its location.
Dim chart As Chart = worksheet.Charts.Add(ChartType.ColumnClustered, worksheet("B2:C8"))
chart.TopLeftCell = worksheet.Cells("F2")
chart.BottomRightCell = worksheet.Cells("N17")

' Change the scale of the value axis.
Dim axisCollection As AxisCollection = chart.PrimaryAxes
Dim valueAxis As Axis = axisCollection(1)
valueAxis.Scaling.AutoMax = False
valueAxis.Scaling.Max = 8000000
valueAxis.Scaling.AutoMin = False
valueAxis.Scaling.Min = 0

' Specify display units for the value axis.
valueAxis.DisplayUnits.UnitType = DisplayUnitType.Thousands
valueAxis.DisplayUnits.ShowLabel = True

' Set the chart style.
chart.Style = ChartStyle.ColorBevel
chart.Views(0).VaryColors = True

' Hide the legend.
chart.Legend.Visible = False