StripLine.Interval Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets the interval for a strip line, and determines if the strip line is drawn once or repeatedly.
public:
property double Interval { double get(); void set(double value); };
[System.ComponentModel.Bindable(true)]
[System.Web.UI.PersistenceMode(System.Web.UI.PersistenceMode.Attribute)]
public double Interval { get; set; }
[<System.ComponentModel.Bindable(true)>]
[<System.Web.UI.PersistenceMode(System.Web.UI.PersistenceMode.Attribute)>]
member this.Interval : double with get, set
Public Property Interval As Double
Property Value
A double
value that represents the interval between strip lines. The default value is 0.0.
- Attributes
Examples
The following code example demonstrates three applications of strip lines. First, horizontal strip lines are added at recurring intervals. Second, vertical strip lines are added to highlight weekend data points. Lastly, a non-recurring strip line is added to denote the mean of the data points in the first series of the chart.
Imports System.Web.UI.DataVisualization.Charting
Public Partial Class StripLines
Inherits System.Web.UI.Page
Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
' Add chart data before adding strip lines.
AddChartData()
' Adds repeating horizontal strip lines.
AddHorizRepeatingStripLines()
' Highlights weekend points using strip lines.
HighlightWeekendsWithStripLines()
' Adds a threshold line using strip lines.
AddThresholdStripLine()
End Sub
''' <summary>
''' Adds a week of data with values between 20 and 35.
''' </summary>
Private Sub AddChartData()
' Declare new random variable
Dim rand As New Random()
For i As Integer = 0 To 6
' Add a week of data
chart1.Series(0).Points.AddXY(DateTime.Now.AddDays(i), rand.[Next](20, 35))
Next
End Sub
''' <summary>
''' Adds repeating horizontal strip lines at intervals of 5.
''' </summary>
Private Sub AddHorizRepeatingStripLines()
' Instantiate new strip line
Dim stripLine1 As New StripLine()
stripLine1.StripWidth = 2.5
stripLine1.Interval = 5
' Consider adding transparency so that the strip lines are lighter
stripLine1.BackColor = Color.FromArgb(120, Color.Red)
' Add the strip line to the chart
chart1.ChartAreas(0).AxisY.StripLines.Add(stripLine1)
End Sub
''' <summary>
''' Adds strip lines to highlight weekend values.
''' </summary>
Private Sub HighlightWeekendsWithStripLines()
' Set strip line to highlight weekends
Dim stripLine2 As New StripLine()
stripLine2.BackColor = Color.FromArgb(120, Color.Gold)
stripLine2.IntervalOffset = -1.5
stripLine2.IntervalOffsetType = DateTimeIntervalType.Days
stripLine2.Interval = 1
stripLine2.IntervalType = DateTimeIntervalType.Weeks
stripLine2.StripWidth = 2
stripLine2.StripWidthType = DateTimeIntervalType.Days
' Add strip line to the chart
chart1.ChartAreas(0).AxisX.StripLines.Add(stripLine2)
' Set the axis label to show the name of the day
' This is done in order to demonstrate that weekends are highlighted
chart1.ChartAreas(0).AxisX.LabelStyle.Format = "ddd"
End Sub
''' <summary>
''' Adds a horizontal threshold strip line at the calculated mean
''' value of all data points in the first series of the chart.
''' </summary>
Private Sub AddThresholdStripLine()
Dim stripLine3 As New StripLine()
' Set threshold line so that it is only shown once
stripLine3.Interval = 0
' Set the threshold line to be drawn at the calculated mean of the first series
stripLine3.IntervalOffset = chart1.DataManipulator.Statistics.Mean(chart1.Series(0).Name)
stripLine3.BackColor = Color.DarkGreen
stripLine3.StripWidth = 0.25
' Set text properties for the threshold line
stripLine3.Text = "Mean"
stripLine3.ForeColor = Color.Black
' Add strip line to the chart
chart1.ChartAreas(0).AxisY.StripLines.Add(stripLine3)
End Sub
End Class
public partial class StripLines : System.Web.UI.Page
{
protected void Page_Load(object sender, EventArgs e)
{
// Add chart data
AddChartData();
// Adds repeating horizontal strip lines.
AddHorizRepeatingStripLines();
// Highlights weekend points using strip lines.
HighlightWeekendsWithStripLines();
// Adds a threshold line using strip lines.
AddThresholdStripLine();
}
/// <summary>
/// Adds a week of data with values between 20 and 35.
/// </summary>
private void AddChartData()
{
// Declare new random variable
Random rand = new Random();
// Add a week of data
for (int i = 0; i < 7; i++)
{
chart1.Series[0].Points.AddXY(DateTime.Now.AddDays(i), rand.Next(20,35));
}
}
/// <summary>
/// Adds repeating horizontal strip lines at intervals of 5.
/// </summary>
private void AddHorizRepeatingStripLines()
{
// Instantiate new strip line
StripLine stripLine1 = new StripLine();
stripLine1.StripWidth = 0;
stripLine1.BorderColor = Color.Black;
stripLine1.BorderWidth = 3;
stripLine1.Interval = 5;
// Consider adding transparency so that the strip lines are lighter
stripLine1.BackColor = Color.FromArgb(120, Color.Red);
stripLine1.BackSecondaryColor = Color.Black;
stripLine1.BackGradientStyle = GradientStyle.LeftRight;
// Add the strip line to the chart
chart1.ChartAreas[0].AxisY.StripLines.Add(stripLine1);
}
/// <summary>
/// Adds strip lines to highlight weekend values.
/// </summary>
private void HighlightWeekendsWithStripLines()
{
// Set strip line to highlight weekends
StripLine stripLine2 = new StripLine();
stripLine2.BackColor = Color.FromArgb(120, Color.Gold);
stripLine2.IntervalOffset = -1.5;
stripLine2.IntervalOffsetType = DateTimeIntervalType.Days;
stripLine2.Interval = 1;
stripLine2.IntervalType = DateTimeIntervalType.Weeks;
stripLine2.StripWidth = 2;
stripLine2.StripWidthType = DateTimeIntervalType.Days;
// Add strip line to the chart
chart1.ChartAreas[0].AxisX.StripLines.Add(stripLine2);
// Set the axis label to show the name of the day
// This is done in order to demonstrate that weekends are highlighted
chart1.ChartAreas[0].AxisX.LabelStyle.Format = "ddd";
}
/// <summary>
/// Adds a horizontal threshold strip line at the calculated mean
/// value of all data points in the first series of the chart.
/// </summary>
private void AddThresholdStripLine()
{
StripLine stripLine3 = new StripLine();
// Set threshold line so that it is only shown once
stripLine3.Interval = 0;
// Set the threshold line to be drawn at the calculated mean of the first series
stripLine3.IntervalOffset = chart1.DataManipulator.Statistics.Mean(chart1.Series[0].Name);
stripLine3.BackColor = Color.DarkGreen;
stripLine3.StripWidth = 0.25;
// Set text properties for the threshold line
stripLine3.Text = "Mean";
stripLine3.ForeColor = Color.Black;
// Add strip line to the chart
chart1.ChartAreas[0].AxisY.StripLines.Add(stripLine3);
}
}
Remarks
When you set the Interval property to a value of zero (0.0), one strip line will be displayed, with a width specified by the StripWidth property. When you set Interval to a value of other than zero, multiple strip lines will be shown. The unit that is used for the Interval property is defined by the IntervalType property.
Applies to
.NET