Class ChartPlotBand

Serves as a base class for NumericalPlotBand, DateTimePlotBand. This class provides options to customize the appearance of plot bands.

Inheritance

System.Object

ChartPlotBand

DateTimePlotBand

NumericalPlotBand

Namespace: Syncfusion.Maui.Toolkit.Charts

Assembly: Syncfusion.Maui.Toolkit.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()

Initializes a new instance of the ChartPlotBand class.

Declaration

public ChartPlotBand()

Fields

AssociatedAxisEndProperty

Identifies the AssociatedAxisEnd bindable property.

Declaration

public static readonly BindableProperty AssociatedAxisEndProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the AssociatedAxisEnd bindable property determines the end value of the associated axis for the plot band.

AssociatedAxisNameProperty

Identifies the AssociatedAxisName bindable property.

Declaration

public static readonly BindableProperty AssociatedAxisNameProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the AssociatedAxisName bindable property determines the name of the associated axis for the plot band.

AssociatedAxisStartProperty

Identifies the AssociatedAxisStart bindable property.

Declaration

public static readonly BindableProperty AssociatedAxisStartProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the AssociatedAxisStart bindable property determines the start value of the associated axis for the plot band.

FillProperty

Identifies the Fill bindable property.

Declaration

public static readonly BindableProperty FillProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the Fill bindable property determines the fill color of the plot band.

IsRepeatableProperty

Identifies the IsRepeatable bindable property.

Declaration

public static readonly BindableProperty IsRepeatableProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the IsRepeatable bindable property determines whether the plot band is repeatable.

IsVisibleProperty

Identifies the IsVisible bindable property.

Declaration

public static readonly BindableProperty IsVisibleProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the IsVisible bindable property determines whether the plot band is visible.

LabelStyleProperty

Identifies the LabelStyle bindable property.

Declaration

public static readonly BindableProperty LabelStyleProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the LabelStyle bindable property determines the style of the label displayed in the plot band.

RepeatEveryProperty

Identifies the RepeatEvery bindable property.

Declaration

public static readonly BindableProperty RepeatEveryProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the RepeatEvery bindable property determines the interval at which the plot band repeats.

SizeProperty

Identifies the Size bindable property.

Declaration

public static readonly BindableProperty SizeProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the Size bindable property determines the size of the plot band.

StrokeDashArrayProperty

Identifies the StrokeDashArray bindable property.

Declaration

public static readonly BindableProperty StrokeDashArrayProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the StrokeDashArray bindable property determines the dash pattern of the stroke for the plot band.

StrokeProperty

Identifies the Stroke bindable property.

Declaration

public static readonly BindableProperty StrokeProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the Stroke bindable property determines the stroke color of the plot band.

StrokeWidthProperty

Identifies the StrokeWidth bindable property.

Declaration

public static readonly BindableProperty StrokeWidthProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the StrokeWidth bindable property determines the width of the stroke for the plot band.

TextProperty

Identifies the Text bindable property.

Declaration

public static readonly BindableProperty TextProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the Text bindable property determines the text displayed in the plot band.

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 and the default value is null.

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 and the default value is string.Empty.

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 and the default value is true.

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.

<chart:SfCartesianChart>

    <chart:SfCartesianChart.XAxes>
        <chart:CategoryAxis>
           <chart:CategoryAxis.PlotBands>
             <chart:NumericalPlotBandCollection>
               <chart:NumericalPlotBand Start="1" Size="1">
                <chart:NumericalPlotBand.LabelStyle>
                 <chart:ChartPlotBandLabelStyle HorizontalTextAlignment="Start" Angle="90"/>
                </chart:NumericalPlotBand.LabelStyle>
              </chart:NumericalPlotBandCollection>
           </chart:CategoryAxis.PlotBands>
       </chart:CategoryAxis>
    </chart:SfCartesianChart.XAxes>

</chart:SfCartesianChart>

SfCartesianChart chart = new SfCartesianChart();

CategoryAxis xaxis = new CategoryAxis();
NumericalPlotBandCollection bands = new NumericalPlotBandCollection();
NumericalPlotBand plotBand = new NumericalPlotBand();
plotBand.Start = 1;
plotBand.Size = 1;
ChartPlotBandLabelStyle style = new ChartPlotBandLabelStyle();
style.HorizontalTextAlignment = ChartLabelAlignment.Start;
style.Angle = 90;
plotBand.LabelStyle = style;
bands.Add(plotBand);
xaxis.PlotBands = bands;

chart.XAxes.Add(xaxis);

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 and the default value is string.Empty.