Class ChartPlotBand
Serves as a base class for NumericalPlotBand, DateTimePlotBand. This class provides options to customize the appearance of plot bands.
Namespace: Syncfusion.Maui.Charts
Assembly: Syncfusion.Maui.Charts.dll
Syntax
public abstract class ChartPlotBand : Element
Remarks
IsVisible - To customize the visibility of plot band, refer to this IsVisible property.
AssociatedAxisStart - To customize the segment start of the plot band, refer to this AssociatedAxisStart property.
AssociatedAxisEnd - To customize the segment end of the plot band, refer to this AssociatedAxisEnd property.
AssociatedAxisName - To set the axis name for the plot band, refer to this AssociatedAxisName property.
Fill - To customize the background color of the plot band, refer to this Fill property.
Stroke - To customize the stroke color, refer to this Stroke property.
StrokeWidth - To customize the stroke width, refer to this StrokeWidth property.
Text - To set the label for the plot band, refer to this Text property.
Size - To customize the width of the plot band, refer to this Size property.
IsRepeatable - To customize the repetition of the plot band, refer to this IsRepeatable property.
LabelStyle - To customize the label for the plot band, refer to this LabelStyle property.
Constructors
ChartPlotBand()
Declaration
public ChartPlotBand()
Fields
AssociatedAxisEndProperty
Identifies the AssociatedAxisEnd bindable property.
Declaration
public static readonly BindableProperty AssociatedAxisEndProperty
Field Value
Type |
---|
Microsoft.Maui.Controls.BindableProperty |
AssociatedAxisNameProperty
Identifies the AssociatedAxisName bindable property.
Declaration
public static readonly BindableProperty AssociatedAxisNameProperty
Field Value
Type |
---|
Microsoft.Maui.Controls.BindableProperty |
AssociatedAxisStartProperty
Identifies the AssociatedAxisStart bindable property.
Declaration
public static readonly BindableProperty AssociatedAxisStartProperty
Field Value
Type |
---|
Microsoft.Maui.Controls.BindableProperty |
FillProperty
Identifies the Fill bindable property.
Declaration
public static readonly BindableProperty FillProperty
Field Value
Type |
---|
Microsoft.Maui.Controls.BindableProperty |
IsRepeatableProperty
Identifies the IsRepeatable bindable property.
Declaration
public static readonly BindableProperty IsRepeatableProperty
Field Value
Type |
---|
Microsoft.Maui.Controls.BindableProperty |
IsVisibleProperty
Identifies the IsVisible bindable property.
Declaration
public static readonly BindableProperty IsVisibleProperty
Field Value
Type |
---|
Microsoft.Maui.Controls.BindableProperty |
LabelStyleProperty
Identifies the LabelStyle bindable property.
Declaration
public static readonly BindableProperty LabelStyleProperty
Field Value
Type |
---|
Microsoft.Maui.Controls.BindableProperty |
RepeatEveryProperty
Identifies the RepeatEvery bindable property.
Declaration
public static readonly BindableProperty RepeatEveryProperty
Field Value
Type |
---|
Microsoft.Maui.Controls.BindableProperty |
SizeProperty
Identifies the Size bindable property.
Declaration
public static readonly BindableProperty SizeProperty
Field Value
Type |
---|
Microsoft.Maui.Controls.BindableProperty |
StrokeDashArrayProperty
Identifies the StrokeDashArray bindable property.
Declaration
public static readonly BindableProperty StrokeDashArrayProperty
Field Value
Type |
---|
Microsoft.Maui.Controls.BindableProperty |
StrokeProperty
Identifies the Stroke bindable property.
Declaration
public static readonly BindableProperty StrokeProperty
Field Value
Type |
---|
Microsoft.Maui.Controls.BindableProperty |
StrokeWidthProperty
Identifies the StrokeWidth bindable property.
Declaration
public static readonly BindableProperty StrokeWidthProperty
Field Value
Type |
---|
Microsoft.Maui.Controls.BindableProperty |
TextProperty
Identifies the Text bindable property.
Declaration
public static readonly BindableProperty TextProperty
Field Value
Type |
---|
Microsoft.Maui.Controls.BindableProperty |
Properties
AssociatedAxisEnd
Gets or sets the end value for the plot band segmentation. It can be a double, date, time or logarithmic value.
Declaration
public object AssociatedAxisEnd { get; set; }
Property Value
Type | Description |
---|---|
System.Object | This property takes System.Object value. |
AssociatedAxisName
Gets or sets the name of the segment axis for the plot band.
Declaration
public string AssociatedAxisName { get; set; }
Property Value
Type | Description |
---|---|
System.String | This property takes System.String value. |
AssociatedAxisStart
Gets or sets the start value for the plot band segmentation. It can be a double, date ,time or logarithmic value.
Declaration
public object AssociatedAxisStart { get; set; }
Property Value
Type | Description |
---|---|
System.Object | This property takes System.Object value. |
Fill
Gets or sets the color of the plot band.
Declaration
public Brush Fill { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.Maui.Controls.Brush | This property takes Microsoft.Maui.Controls.Brush value. |
IsRepeatable
Gets or sets the bool value to indicate the plot band recurrence.
Declaration
public bool IsRepeatable { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | This property takes the System.Boolean value. Its default value is false. |
IsVisible
Gets or sets a value indicating whether the plot band is visible on the axis.
Declaration
public bool IsVisible { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | It accepts System.Boolean values. |
LabelStyle
Gets or sets the customized style for the plot band labels.
Declaration
public ChartPlotBandLabelStyle LabelStyle { get; set; }
Property Value
Type | Description |
---|---|
ChartPlotBandLabelStyle | This property takes the ChartPlotBandLabelStyle as its value. |
RepeatEvery
Gets or sets the frequency of the plot band.
Declaration
public double RepeatEvery { get; set; }
Property Value
Type | Description |
---|---|
System.Double | This property takes the System.Double value. Its default value is double.NaN. |
Size
Gets or sets the size of the plot band.
Declaration
public double Size { get; set; }
Property Value
Type | Description |
---|---|
System.Double | This property takes the System.Double value. Its default value is double.NaN. |
Stroke
Gets or sets a value to customize the outer stroke appearance of the plot band.
Declaration
public Brush Stroke { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.Maui.Controls.Brush | It accepts Microsoft.Maui.Controls.Brush values. |
StrokeDashArray
Gets or sets the stroke dash array to customize the appearance of the stroke.
Declaration
public DoubleCollection StrokeDashArray { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.Maui.Controls.DoubleCollection | It accepts the Microsoft.Maui.Controls.DoubleCollection value and the default value is null. |
StrokeWidth
Gets or sets a value that indicates the stroke thickness of the plot band.
Declaration
public double StrokeWidth { get; set; }
Property Value
Type | Description |
---|---|
System.Double | It accepts System.Double values and the default value is 1. |
Text
Gets or sets the text to be displayed on the plot band.
Declaration
public string Text { get; set; }
Property Value
Type | Description |
---|---|
System.String | This property takes the System.String value. |
Methods
OnBindingContextChanged()
Declaration
protected override void OnBindingContextChanged()
OnParentSet()
Declaration
protected override void OnParentSet()