menu

MAUI Toolkit

  • User Guide
  • Demos
  • Support
Class NumericalPlotBand - MAUI-ToolKit API Reference | Syncfusion

    Show / Hide Table of Contents

    Class NumericalPlotBand

    The NumericalPlotBand class can be used to render plot band using numerical, category, and logarithmic values.

    Inheritance
    System.Object
    ChartPlotBand
    NumericalPlotBand
    Inherited Members
    ChartPlotBand.AssociatedAxisEnd
    ChartPlotBand.AssociatedAxisEndProperty
    ChartPlotBand.AssociatedAxisName
    ChartPlotBand.AssociatedAxisNameProperty
    ChartPlotBand.AssociatedAxisStart
    ChartPlotBand.AssociatedAxisStartProperty
    ChartPlotBand.Fill
    ChartPlotBand.FillProperty
    ChartPlotBand.IsRepeatable
    ChartPlotBand.IsRepeatableProperty
    ChartPlotBand.IsVisible
    ChartPlotBand.IsVisibleProperty
    ChartPlotBand.LabelStyle
    ChartPlotBand.LabelStyleProperty
    ChartPlotBand.RepeatEvery
    ChartPlotBand.RepeatEveryProperty
    ChartPlotBand.Size
    ChartPlotBand.SizeProperty
    ChartPlotBand.Stroke
    ChartPlotBand.StrokeDashArray
    ChartPlotBand.StrokeDashArrayProperty
    ChartPlotBand.StrokeProperty
    ChartPlotBand.StrokeWidth
    ChartPlotBand.StrokeWidthProperty
    ChartPlotBand.Text
    ChartPlotBand.TextProperty
    Namespace: Syncfusion.Maui.Toolkit.Charts
    Assembly: Syncfusion.Maui.Toolkit.dll
    Syntax
    public class NumericalPlotBand : ChartPlotBand
    Remarks

    NumericalPlotBand requires Start and End properties to be set to render the Plot band.

    Examples
    • Xaml
    • C#
    <chart:SfCartesianChart>
    
        <chart:SfCartesianChart.XAxes>
            <chart:CategoryAxis>
               <chart:CategoryAxis.PlotBands>
                    <chart:NumericalPlotBandCollection>
                        <chart:NumericalPlotBand Start="1" End="2"/>
                    </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.End = 2;
    bands.Add(plotBand);
    xAxis.PlotBands = bands;
    
    chart.XAxes.Add(xAxis);

    Constructors

    NumericalPlotBand()

    Declaration
    public NumericalPlotBand()

    Fields

    EndProperty

    Identifies the End bindable property.

    Declaration
    public static readonly BindableProperty EndProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty
    Remarks

    The identifier for the End bindable property determines the end value of the plot band.

    RepeatUntilProperty

    Identifies the RepeatUntil bindable property.

    Declaration
    public static readonly BindableProperty RepeatUntilProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty
    Remarks

    The identifier for the RepeatUntil bindable property determines the value until which the plot band repeats.

    StartProperty

    Identifies the Start bindable property.

    Declaration
    public static readonly BindableProperty StartProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty
    Remarks

    The identifier for the Start bindable property determines the start value of the plot band.

    Properties

    End

    Gets or sets the axis value representing where the plot bands should end on the axis.

    Declaration
    public double End { get; set; }
    Property Value
    Type Description
    System.Double

    This property takes the System.Double value. Its default value is double.NaN.

    RepeatUntil

    Gets or sets the axis value that determines how long the plot band will be repeated along the axis.

    Declaration
    public double RepeatUntil { get; set; }
    Property Value
    Type Description
    System.Double

    This property takes the System.Double value and the default value is double.NaN.

    Examples
    • Xaml
    • C#
        <chart:SfCartesianChart>
           <chart:SfCartesianChart.XAxes>
              <chart:CategoryAxis>
                 <chart:CategoryAxis.PlotBands>
                    <chart:NumericalPlotBandCollection>
                        <chart:NumericalPlotBand Start="1" End="1" RepeatUntil="4" RepeatEvery="2"/>
                    </chart:NumericalPlotBandCollection>
                 </chart:CategoryAxis.PlotBands>
                </chart:CategoryAxis>
            </chart:SfCartesianChart.XAxes>
        <!-- ... Eliminated for simplicity-->             
        </chart:SfCartesianChart>
        SfCartesianChart chart = new SfCartesianChart();
    
        CategoryAxis xAxis = new CategoryAxis();
        NumericalPlotBandCollection bands = new NumericalPlotBandCollection();
        NumericalPlotBand plotBand = new NumericalPlotBand();
        plotBand.Start = 1;
        plotBand.End = 1;
        plotBand.RepeatUntil = 4;
        plotBand.RepeatEvery = 2;
        bands.Add(plotBand);
        xAxis.PlotBands = bands;
    
        chart.XAxes.Add(xAxis);

    Start

    Gets or sets the axis value representing where the plot bands should start on the axis.

    Declaration
    public double Start { get; set; }
    Property Value
    Type Description
    System.Double

    This property takes the System.Double value and the default value is double.NaN.

    Examples
    • Xaml
    • C#
        <chart:SfCartesianChart>
           <chart:SfCartesianChart.XAxes>
              <chart:CategoryAxis>
                 <chart:CategoryAxis.PlotBands>
                    <chart:NumericalPlotBandCollection>
                        <chart:NumericalPlotBand Start="1" End="2"/>
                    </chart:NumericalPlotBandCollection>
                 </chart:CategoryAxis.PlotBands>
                </chart:CategoryAxis>
            </chart:SfCartesianChart.XAxes>
        <!-- ... Eliminated for simplicity-->             
        </chart:SfCartesianChart>
        SfCartesianChart chart = new SfCartesianChart();
    
        CategoryAxis xAxis = new CategoryAxis();
        NumericalPlotBandCollection bands = new NumericalPlotBandCollection();
        NumericalPlotBand plotBand = new NumericalPlotBand();
        plotBand.Start = 1;
        plotBand.End = 2;
        bands.Add(plotBand);
        xAxis.PlotBands = bands;
    
        chart.XAxes.Add(xAxis);
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved