StripLine Class

Represents the strip lines on a chart.

System.Object
  System.Web.UI.DataVisualization.Charting.ChartElement
    System.Web.UI.DataVisualization.Charting.StripLine

Namespace:  System.Web.UI.DataVisualization.Charting
Assembly:  System.Web.DataVisualization (in System.Web.DataVisualization.dll)

'Declaration
Public Class StripLine _
	Inherits ChartElement _
	Implements IChartMapArea

The StripLine type exposes the following members.

  NameDescription
Public methodStripLineInitializes a new instance of the StripLine class.
Top

  NameDescription
Public propertyBackColorGets or sets the background color of the strip line.
Public propertyBackGradientStyleGets or sets the gradient style of the strip line.
Public propertyBackHatchStyleGets or sets the hatching style of the strip line.
Public propertyBackImageGets or sets the background image of the strip line.
Public propertyBackImageAlignmentGets or sets the background image alignment.
Public propertyBackImageTransparentColorGets or sets the color of a strip line background image that will be implemented as transparent.
Public propertyBackImageWrapModeGets or sets the drawing mode of the background image of the strip line.
Public propertyBackSecondaryColorGets or sets the secondary color of the strip line background.
Public propertyBorderColorGets or sets the border color of a strip line.
Public propertyBorderDashStyleGets or sets the border style of the strip line.
Public propertyBorderWidthGets or sets the border width of the strip line.
Public propertyFontGets or sets the font used for the strip line text.
Public propertyForeColorGets or sets the color of the strip line text.
Public propertyIntervalGets or sets the interval for a strip line, and determines if the strip line is drawn once or repeatedly.
Public propertyIntervalOffsetGets or sets the offset of grid lines, tick marks, strip lines and axis labels.
Public propertyIntervalOffsetTypeGets or sets the interval offset type of the strip line.
Public propertyIntervalTypeGets or sets the interval type of a StripLine object.
Public propertyMapAreaAttributesGets or sets the map area attributes of the strip line.
Public propertyNameGets the name of the strip line.
Public propertyPostBackValueGets or sets the postback value that can be processed on a Click event.
Public propertyStripWidthGets or sets the width of a strip line.
Public propertyStripWidthTypeGets or sets the unit of measurement for the StripWidth property.
Public propertyTagGets or sets an object associated with this chart element. (Inherited from ChartElement.)
Public propertyTextGets or sets the text for the strip line.
Public propertyTextAlignmentGets or sets the text alignment of the strip line.
Public propertyTextLineAlignmentGets or sets the text line alignment of strip line text.
Public propertyTextOrientationGets or sets the text orientation.
Public propertyToolTipGets or sets the tooltip of a strip line.
Public propertyUrlGets or sets the destination URL or anchor point of the strip line.
Top

  NameDescription
Public methodDisposeReleases the resources used by the ChartElement. (Inherited from ChartElement.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the StripLine and optionally releases the managed resources. (Overrides ChartElement.Dispose(Boolean).)
Public methodEqualsDetermines whether the specified Object is equal to the current ChartElement. (Inherited from ChartElement.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns a hash function for a particular type. (Inherited from ChartElement.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current Object. (Inherited from ChartElement.)
Top

Strip lines, or strips, are horizontal or vertical ranges that shade the background of a chart in regular or custom intervals. You can use strip lines to:

  • Improve readability for looking up individual values on the chart.

  • Separate data points when reading the chart.

  • Highlight dates that occur at regular intervals, for example, to identify weekend data points.

  • Highlight a specific key range of data.

  • Add a threshold line at a specific constant value.

A single StripLine object can either be drawn once, or repeatedly, for a given interval. This action is controlled by the Interval property. When a value of -1 is assigned to the Interval property, one strip line will be drawn. When a non-zero value is assigned to the Interval property, a strip line will be drawn repeatedly at each given interval. The location where a strip line is drawn is also affected by the IntervalOffset and IntervalOffsetType properties of the strip line.

Strip lines are always associated with an Axis object. They can be added at both design time and run time.

To add a horizontal or vertical line to display a threshold, set the StripWidth property to a value of 0.0. This will result in a line being drawn. You can use the BorderColor, BorderDashStyle and BorderWidth properties for the color, width and style of the line. No chart background properties (Back*) are used when the StripWidth property is set to 0.0.

Use the Text property of the strip line to associate text with a strip line. The placement and orientation of this text can be controlled by the TextAlignment property.

When multiple strip lines are defined for the same axis, it is possible that the strip lines will overlap. The Z-order of StripLine objects is determined by their order of occurrence in the StripLinesCollection object. This means that the first occurrence is drawn first; the second occurrence is drawn second, and so on.

Strip lines are not supported for the following chart types: Pie, Doughnut, Funnel, Pyramid, Kagi, ThreeLineBreak, PointAndFigure, Polar and Radar.

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 
    
    ' Adds a week of data with values between 20 and 35. 
    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 
    
    ' Adds repeating horizontal strip lines at intervals of 5. 
    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 
    
    ' Adds strip lines to highlight weekend values. 
    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 
    
    ' Adds a horizontal threshold strip line at the mean value of the first series.
    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

.NET Framework

Supported in: 4.5, 4

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft