FunnelSeriesView.HeightToWidthRatioAuto Property

Gets or sets a value which indicates whether the height-to-width ratio of a Funnel series should be auto-calculated.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v22.2.dll

NuGet Package: DevExpress.Charts

Declaration

C#

[XtraChartsLocalizableCategory(XtraChartsCategory.Layout)]
public bool HeightToWidthRatioAuto { get; set; }

VB.NET

<XtraChartsLocalizableCategory(XtraChartsCategory.Layout)>
Public Property HeightToWidthRatioAuto As Boolean

Property Value

Type	Description
Boolean	true if the height-to-width ratio should be auto-calculated; otherwise, false.

Remarks

Use the HeightToWidthRatioAuto property, to toggle between automatic and manual height-to-width ratio definition for Funnel series.

If the HeightToWidthRatioAuto property is set to false, the FunnelSeriesViewBase.HeightToWidthRatio property becomes available, which allows you to manually define the desired ratio.

The following images demonstrate the HeightToWidthRatioAuto property in action.

HeightToWidthRatioAuto = true	HeightToWidthRatioAuto = false HeightToWidthRatio = 1

Example

The example demonstrates how to create a ChartControl with a series of the FunnelSeriesView type, and add this chart to a form at runtime.

C#

using System;
using System.Windows.Forms;
using DevExpress.XtraCharts;
// ...

namespace Series_Funnel {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
        }

        private void Form1_Load(object sender, EventArgs e) {
            // Create a new chart.
            ChartControl funnelChart = new ChartControl();

            // Create a funnel series.
            Series series1 = new Series("A Funnel Series", ViewType.Funnel);

            // Add points to the series.
            series1.Points.Add(new SeriesPoint("A", 48.5));
            series1.Points.Add(new SeriesPoint("B", 29.6));
            series1.Points.Add(new SeriesPoint("C", 17.1));
            series1.Points.Add(new SeriesPoint("D", 13.3));
            series1.Points.Add(new SeriesPoint("E", 11.6));

            // Add the series to the chart.
            funnelChart.Series.Add(series1);

            // Adjust the view-type specific properties of the series.
            FunnelSeriesView myView = (FunnelSeriesView)series1.View;

            myView.Titles.Add(new SeriesTitle());
            myView.Titles[0].Text = series1.Name;
            myView.HeightToWidthRatioAuto = false;
            myView.HeightToWidthRatio = 1.5;
            myView.PointDistance = 10;

            // Adjust the point options of the series.
            series1.Label.TextPattern = "{A}: {VP:p0}";

            // Specify the series labels position.
            ((FunnelSeriesLabel)series1.Label).Position = FunnelSeriesLabelPosition.RightColumn;

            // Hide the legend (if necessary).
            funnelChart.Legend.Visibility = DevExpress.Utils.DefaultBoolean.False;

            // Add the chart to the form.
            funnelChart.Dock = DockStyle.Fill;
            this.Controls.Add(funnelChart);
        }
    }
}

VB.NET

Imports System
Imports System.Windows.Forms
Imports DevExpress.XtraCharts
' ...

Namespace Series_Funnel
    Partial Public Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
            ' Create a new chart.
            Dim funnelChart As New ChartControl()

            ' Create a funnel series.
            Dim series1 As New Series("A Funnel Series", ViewType.Funnel)

            ' Add points to the series.
            series1.Points.Add(New SeriesPoint("A", 48.5))
            series1.Points.Add(New SeriesPoint("B", 29.6))
            series1.Points.Add(New SeriesPoint("C", 17.1))
            series1.Points.Add(New SeriesPoint("D", 13.3))
            series1.Points.Add(New SeriesPoint("E", 11.6))

            ' Add the series to the chart.
            funnelChart.Series.Add(series1)

            ' Adjust the view-type specific properties of the series.
            Dim myView As FunnelSeriesView = CType(series1.View, FunnelSeriesView)

            myView.Titles.Add(New SeriesTitle())
            myView.Titles(0).Text = series1.Name
            myView.HeightToWidthRatioAuto = False
            myView.HeightToWidthRatio = 1.5
            myView.PointDistance = 10

            ' Adjust the point options of the series.
            series1.Label.TextPattern = "{A}: {VP:p0}"

            ' Specify the series labels position.
            CType(series1.Label, FunnelSeriesLabel).Position = FunnelSeriesLabelPosition.RightColumn

            ' Hide the legend (if necessary).
            funnelChart.Legend.Visibility = DevExpress.Utils.DefaultBoolean.False

            ' Add the chart to the form.
            funnelChart.Dock = DockStyle.Fill
            Me.Controls.Add(funnelChart)
        End Sub
    End Class
End Namespace