Back to Devexpress

SparklineVerticalAxis.MaxScaleType Property

officefileapi-devexpress-dot-spreadsheet-dot-sparklineverticalaxis-bbad06b5.md

latest4.8 KB
Original Source

SparklineVerticalAxis.MaxScaleType Property

Gets or sets a value that specifies the way to calculate the maximum value of the vertical axis for the sparkline group.

Namespace : DevExpress.Spreadsheet

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
SparklineAxisScaling MaxScaleType { get; set; }
vb
Property MaxScaleType As SparklineAxisScaling

Property Value

TypeDescription
SparklineAxisScaling

A SparklineAxisScaling enumeration value that specifies how to evaluate the maximum value of the axis.

|

Available values:

NameDescription
Individual

Specifies that the minimum or maximum value for the sparkline vertical axis should be automatically set to the lowest or highest value calculated individually for each sparkline in the group.

| | Custom |

Specifies that the minimum or maximum value for the sparkline vertical axis should be set to the custom value defined by the SparklineVerticalAxis.MinCustomValue or SparklineVerticalAxis.MaxCustomValue property, respectively.

| | Group |

Specifies that the minimum or maximum value for the sparkline vertical axis should be calculated automatically and shared across all the sparklines in the group.

|

Remarks

Use the MaxScaleType and SparklineVerticalAxis.MinScaleType properties to specify whether all sparklines in the group have the same scale value (SparklineAxisScaling.Group), or it should be calculated individually for each sparkline in the group (SparklineAxisScaling.Individual).

You can also set the minimum and maximum axis values to your own custom values (SparklineAxisScaling.Custom) by using the SparklineVerticalAxis.MinCustomValue and SparklineVerticalAxis.MaxCustomValue properties.

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the MaxScaleType property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

spreadsheet-document-api-chart-examples/CS/SpreadsheetDocServerChartAPISamples/CodeExamples/SparklineActions.cs#L88

csharp
// Set the custom maximum value for the vertical axis.
verticalAxis.MaxScaleType = SparklineAxisScaling.Custom;
verticalAxis.MaxCustomValue = 12000;

spreadsheet-document-api-chart-examples/VB/SpreadsheetDocServerChartAPISamples/CodeExamples/SparklineActions.vb#L85

vb
' Set the custom maximum value for the vertical axis.
verticalAxis.MaxScaleType = SparklineAxisScaling.Custom
verticalAxis.MaxCustomValue = 12000

See Also

MinScaleType

How to: Specify Sparkline Axis Settings

SparklineVerticalAxis Interface

SparklineVerticalAxis Members

DevExpress.Spreadsheet Namespace