Class ChartStripLine
Represents ChartStripLine class. Contains the information about strip line.
Inheritance
Implements
Namespace: Syncfusion.Windows.Chart
Assembly: Syncfusion.Chart.Wpf.dll
Syntax
public class ChartStripLine : FrameworkElement, IDisposable
Remarks
Chart WPF enables the user to highlight a specific area of the chart by adding StripLines to a ChartAxis. The strip lines length and width can be customized, a text label can be specified and the look and feel can be customized too.
Examples
//Create a new Stripline
ChartStripLine csX = new ChartStripLine();
//Set whether this need to started from X Axis
csX.StartFromAxis = true;
//Set the offset from where this stripline should be placed
csX.Offset = 2;
//Set the width of the stripline
csX.Width = 0.2;
//Set the interior of the stripline
csX.Interior = App.Current.Resources["imgBrush"] as ImageBrush;
//Set the FormattedText of the Stripline
csX.Text = new FormattedText("",
CultureInfo.CurrentCulture,FlowDirection.LeftToRight, new Typeface("Arial"), 20,
Brushes.Black);
//Add the stripline to the Axis stripline collection
chart1.Areas[0].PrimaryAxis.StripLines.Add(csX);
Constructors
ChartStripLine()
Declaration
public ChartStripLine()
Fields
AxisProperty
Using a DependencyProperty as the backing store for Axis. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty AxisProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
InteriorProperty
Using a DependencyProperty as the backing store for Interior. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty InteriorProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
IsPixelWidthProperty
Identifies the Pixel width for the StripLine
Declaration
public static readonly DependencyProperty IsPixelWidthProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
IsSegmentedProperty
Identifies the IsSegmented value for the StripLine
Declaration
public static readonly DependencyProperty IsSegmentedProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
OffsetProperty
Using a DependencyProperty as the backing store for Offset. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty OffsetProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
RepeatEveryProperty
Using a DependencyProperty as the backing store for Period. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty RepeatEveryProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
RepeatUntilProperty
Using a DependencyProperty as the backing store for End. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty RepeatUntilProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
SegmentEndValueProperty
Identifies the Segmented end value for the StripLine
Declaration
public static readonly DependencyProperty SegmentEndValueProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
SegmentStartValueProperty
Identifies the Segmented Start value for the StripLine
Declaration
public static readonly DependencyProperty SegmentStartValueProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
StartFromAxisProperty
Using a DependencyProperty as the backing store for StartFromAxis. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty StartFromAxisProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
StartProperty
Using a DependencyProperty as the backing store for Start. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty StartProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
StrokeProperty
Using a DependencyProperty as the backing store for Stroke. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty StrokeProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
TextAlignmentProperty
Using a DependencyProperty as the backing store for Alignment. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty TextAlignmentProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
TextBackgroundProperty
Using a DependencyProperty for the TextBackground
Declaration
public static readonly DependencyProperty TextBackgroundProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
TextOffsetXProperty
Identifies the Text OffsetX value for the StripLine
Declaration
public static readonly DependencyProperty TextOffsetXProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
TextOffsetYProperty
Identifies the TextOffsetY value for the StripLine
Declaration
public static readonly DependencyProperty TextOffsetYProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
TextProperty
Using a DependencyProperty as the backing store for Text. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty TextProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
TextRotationAngleProperty
Using a DependencyProperty as the backing store for TextRotationAngle. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty TextRotationAngleProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
VerticalTextProperty
Using a DependencyProperty for the VerticalText
Declaration
public static readonly DependencyProperty VerticalTextProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
WidthProperty
Using a DependencyProperty as the backing store for Width. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty WidthProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
Properties
Axis
Gets the axis.
Declaration
public ChartAxis Axis { get; }
Property Value
Type | Description |
---|---|
ChartAxis | The axis value. |
Interior
Gets or sets the interior.
Declaration
public Brush Interior { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Media.Brush | The interior. |
IsPixelWidth
Gets or sets the IsPixelWidth.
Declaration
public bool IsPixelWidth { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The IsPixelWidth. |
IsSegmented
gets or sets the IsSegmented value
Declaration
public bool IsSegmented { get; set; }
Property Value
Type |
---|
System.Boolean |
Offset
Gets or sets the offset.
Declaration
public double Offset { get; set; }
Property Value
Type | Description |
---|---|
System.Double | A double value in axis range metrics. |
RepeatEvery
Gets or sets the repeat every.
Declaration
public double RepeatEvery { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The repeat every. |
RepeatUntil
Gets or sets the repeat until.
Declaration
public double RepeatUntil { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The repeat until. |
SegmentEndValue
gets or sets the Segment end value
Declaration
public double SegmentEndValue { get; set; }
Property Value
Type |
---|
System.Double |
SegmentStartValue
gets or sets the Segment start value
Declaration
public double SegmentStartValue { get; set; }
Property Value
Type |
---|
System.Double |
Start
Gets or sets the start.
Declaration
public double Start { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The start. |
StartFromAxis
Gets or sets a value indicating whether [start from axis].
Declaration
public bool StartFromAxis { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | True if the stripline should start from the beginning of the axis. False, otherwise. |
Stroke
Gets or sets the stroke.
Declaration
public Pen Stroke { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Media.Pen | The stroke. |
Text
Gets or sets the text.
Declaration
public FormattedText Text { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Media.FormattedText | The text value. |
TextAlignment
Gets or sets the text alignment.
Declaration
public ChartAlignment TextAlignment { get; set; }
Property Value
Type | Description |
---|---|
ChartAlignment | The text alignment. |
TextBackground
Gets or sets the Background of stripline text area.
Declaration
public Brush TextBackground { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Media.Brush | The textBackground. |
TextOffsetX
Gets or sets the text offset X.
Declaration
public double TextOffsetX { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The text offset X. |
TextOffsetY
Gets or sets the text offset Y.
Declaration
public double TextOffsetY { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The text offset Y. |
TextRotationAngle
Gets or sets the Rotation Angle of the stripline text
Declaration
public int TextRotationAngle { get; set; }
Property Value
Type |
---|
System.Int32 |
VerticalText
Gets or sets a value indicating whether [vertical text].
Declaration
public bool VerticalText { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
Width
Gets or sets the width.
Declaration
public double Width { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The width. |
Methods
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Declaration
public void Dispose()
OnPropertyChanged(DependencyPropertyChangedEventArgs)
Invoked whenever the effective value of any dependency property on this System.Windows.DependencyObject has been updated. The specific dependency property that changed is reported in the event data.
Declaration
protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.DependencyPropertyChangedEventArgs | e | Event data that will contain the dependency property identifier of interest, the property metadata for the type, and old and new values. |