IntervalOptionsBase.UnderflowValuePattern Property

Gets or sets a format string that configures text for the underflow interval axis labels and crosshair labels.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v20.1.dll

Declaration

public string UnderflowValuePattern { get; set; }
Public Property UnderflowValuePattern As String

Property Value

Type Description
String

A format string.

Property Paths

You can access this nested property as listed below:

Show 75 property paths
Object Type Path to UnderflowValuePattern
Axis
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
Axis
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
Axis
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
Axis2D
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
Axis2D
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
Axis2D
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
Axis3D
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
Axis3D
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
Axis3D
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
AxisBase
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
AxisBase
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
AxisBase
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
AxisX
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
AxisX
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
AxisX
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
AxisX3D
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
AxisX3D
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
AxisX3D
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
AxisXBase
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
AxisXBase
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
AxisXBase
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
AxisY
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
AxisY
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
AxisY
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
AxisY3D
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
AxisY3D
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
AxisY3D
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
AxisYBase
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
AxisYBase
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
AxisYBase
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
DateTimeScaleOptions
.IntervalOptions.UnderflowValuePattern
GanttAxisX
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
GanttAxisX
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
GanttAxisX
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
NumericScaleOptions
.IntervalOptions.UnderflowValuePattern
PolarAxisX
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
PolarAxisX
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
PolarAxisX
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
RadarAxis
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
RadarAxis
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
RadarAxis
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
RadarAxisX
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
RadarAxisX
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
RadarAxisX
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
RadarAxisY
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
RadarAxisY
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
RadarAxisY
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
SecondaryAxisX
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
SecondaryAxisX
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
SecondaryAxisX
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
SecondaryAxisY
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
SecondaryAxisY
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
SecondaryAxisY
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramAxis
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramAxis
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramAxis
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramAxisX
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramAxisX
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramAxisX
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramAxisXBase
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramAxisXBase
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramAxisXBase
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramAxisY
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramAxisY
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramAxisY
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramAxisYBase
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramAxisYBase
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramAxisYBase
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramSecondaryAxisX
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramSecondaryAxisX
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramSecondaryAxisX
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramSecondaryAxisY
.NumericScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramSecondaryAxisY
.DateTimeScaleOptions.IntervalOptions.UnderflowValuePattern
SwiftPlotDiagramSecondaryAxisY
.TimeSpanScaleOptions.IntervalOptions.UnderflowValuePattern
TimeSpanScaleOptions
.IntervalOptions.UnderflowValuePattern

Remarks

Patterns can contain regular text (displayed as is) and value placeholders in braces. To format numeric and date/time values, you can apply Format Specifiers. Use a colon to separate a placeholder and its format specifier.

The following table contains the available placeholders:

Placeholder Description
{OB} Displays an opening bracket.
{CB} Displays a closing bracket.
{A2} Displays the interval end value.

Examples

This example demonstrates how to create a histogram chart with bins of a given width.

private void Form1_Load(object sender, EventArgs e) {
    // Load data to a chart.
    chartControl1.DataSource = LoadDataTableFromXml("..\\..\\Data\\CityWeather.xml", "CityWeather");
    Series series = new Series();
    series.ArgumentDataMember = "Temperature";
    SideBySideBarSeriesView view = series.View as SideBySideBarSeriesView;
    view.Border.Visibility = DevExpress.Utils.DefaultBoolean.True;
    view.BarWidth = 1;
    chartControl1.Series.Add(series);
    // Configure histogram options.
    XYDiagram diagram = chartControl1.Diagram as XYDiagram; 
    NumericScaleOptions scaleOptions = diagram.AxisX.NumericScaleOptions;
    scaleOptions.AggregateFunction = AggregateFunction.Histogram;
    scaleOptions.ScaleMode = ScaleMode.Interval;
    scaleOptions.IntervalOptions.DivisionMode = IntervalDivisionMode.Width;
    scaleOptions.IntervalOptions.Width = 10;
    scaleOptions.IntervalOptions.OverflowValue = 20;
    scaleOptions.IntervalOptions.UnderflowValue = -30;
    scaleOptions.IntervalOptions.Pattern = "{OB}{A1:F0} ― {A2:F0}{CB}";
    scaleOptions.IntervalOptions.OverflowValuePattern = "{OS} {A1}";
    scaleOptions.IntervalOptions.UnderflowValuePattern = "{US} {A2}";
    scaleOptions.IntervalOptions.GridLayoutMode = GridLayoutMode.GridShiftedLabelCentered;
    diagram.AxisX.GridLines.Visible = true;
    diagram.AxisX.Tickmarks.MinorVisible = false;
}
static DataTable LoadDataTableFromXml(string fileName, string tableName) {
    DataSet xmlDataSet = new DataSet();
    xmlDataSet.ReadXml(fileName);
    return xmlDataSet.Tables[tableName];
}

The following API members configure the histogram options:

Member Description
ScaleGridOptionsBase.AggregateFunction Gets or sets the value indicating the aggregate function that should be used to relieve data.
ScaleOptionsBase.ScaleMode Gets or sets the scale mode for an axis.
NumericScaleOptions.IntervalOptions Stores options for numeric axis when its ScaleMode is Interval.
NumericIntervalOptions.DivisionMode Specifies how to divide axis scale into intervals.
NumericIntervalOptions.Width Gets or sets the interval size when DivisionMode is Width.
NumericIntervalOptions.OverflowValue Gets or sets the start value for the interval that includes overflow values.
NumericIntervalOptions.UnderflowValue Gets or sets the end value for the interval that includes underflow values.
IntervalOptionsBase.Pattern Gets or sets a format string that configures text for the interval axis labels and crosshair labels.
IntervalOptionsBase.OverflowValuePattern Gets or sets a format string that configures text for the overflow interval axis labels and crosshair labels.
IntervalOptionsBase.UnderflowValuePattern Gets or sets a format string that configures text for the underflow interval axis labels and crosshair labels.
NumericIntervalOptions.GridLayoutMode Gets or sets the value that specifies the alignment of grid lines, major tickmarks and axis labels.
See Also