IntervalOptionsBase.OverflowValuePattern Property

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

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v20.1.dll

Declaration

public string OverflowValuePattern { get; set; }
Public Property OverflowValuePattern 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 OverflowValuePattern
Axis
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
Axis
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
Axis
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
Axis2D
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
Axis2D
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
Axis2D
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
Axis3D
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
Axis3D
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
Axis3D
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
AxisBase
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
AxisBase
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
AxisBase
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
AxisX
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
AxisX
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
AxisX
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
AxisX3D
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
AxisX3D
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
AxisX3D
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
AxisXBase
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
AxisXBase
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
AxisXBase
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
AxisY
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
AxisY
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
AxisY
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
AxisY3D
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
AxisY3D
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
AxisY3D
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
AxisYBase
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
AxisYBase
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
AxisYBase
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
DateTimeScaleOptions
.IntervalOptions.OverflowValuePattern
GanttAxisX
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
GanttAxisX
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
GanttAxisX
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
NumericScaleOptions
.IntervalOptions.OverflowValuePattern
PolarAxisX
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
PolarAxisX
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
PolarAxisX
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
RadarAxis
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
RadarAxis
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
RadarAxis
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
RadarAxisX
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
RadarAxisX
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
RadarAxisX
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
RadarAxisY
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
RadarAxisY
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
RadarAxisY
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
SecondaryAxisX
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
SecondaryAxisX
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
SecondaryAxisX
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
SecondaryAxisY
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
SecondaryAxisY
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
SecondaryAxisY
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramAxis
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramAxis
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramAxis
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramAxisX
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramAxisX
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramAxisX
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramAxisXBase
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramAxisXBase
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramAxisXBase
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramAxisY
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramAxisY
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramAxisY
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramAxisYBase
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramAxisYBase
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramAxisYBase
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramSecondaryAxisX
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramSecondaryAxisX
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramSecondaryAxisX
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramSecondaryAxisY
.NumericScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramSecondaryAxisY
.DateTimeScaleOptions.IntervalOptions.OverflowValuePattern
SwiftPlotDiagramSecondaryAxisY
.TimeSpanScaleOptions.IntervalOptions.OverflowValuePattern
TimeSpanScaleOptions
.IntervalOptions.OverflowValuePattern

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.
{A1} Displays the interval start 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