Back to Devexpress

HeatmapControl.EnableAxisXScrolling Property

windowsforms-devexpress-dot-xtracharts-dot-heatmap-dot-heatmapcontrol-0adcdaec.md

latest6.2 KB
Original Source

HeatmapControl.EnableAxisXScrolling Property

Specifies whether a user can scroll the heatmap horizontally.

Namespace : DevExpress.XtraCharts.Heatmap

Assembly : DevExpress.XtraCharts.v25.2.UI.dll

NuGet Package : DevExpress.Win.Charts

Declaration

csharp
[DefaultValue(false)]
public bool EnableAxisXScrolling { get; set; }
vb
<DefaultValue(False)>
Public Property EnableAxisXScrolling As Boolean

Property Value

TypeDefaultDescription
Booleanfalse

true if the heatmap can be scrolled horizontally (along an x-axis); otherwise, false.

|

Remarks

The following properties allow you to enable navigation in the Heatmap Control:

To check whether zoom or scroll operations are available, use the IsScrollingEnabled and IsZoomingEnabled properties.

Use the methods below to zoom and scroll a heatmap programmatically:

Call the HeatmapControl.ResetZoom() method to reset the current zoom state to the default value.

Example

The following code enables zoom and scroll operations in a heatmap:

csharp
using DevExpress.XtraCharts.Heatmap;

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

            HeatmapControl heatmap = new HeatmapControl();
            this.Controls.Add(heatmap);
            //...
            heatmap.EnableAxisXScrolling = true;
            heatmap.EnableAxisYScrolling = true;
            heatmap.EnableAxisXZooming = true;
            heatmap.EnableAxisYZooming = true;
        }
    }
}
vb
Imports DevExpress.XtraCharts.Heatmap

Namespace HeatmapChart
    Public Partial Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
            Dim heatmap As HeatmapControl = New HeatmapControl()
            Me.Controls.Add(heatmap)
            '...
            heatmap.EnableAxisXScrolling = True
            heatmap.EnableAxisYScrolling = True
            heatmap.EnableAxisXZooming = True
            heatmap.EnableAxisYZooming = True
        End Sub
    End Class
End Namespace

The following code snippets (auto-collected from DevExpress Examples) contain references to the EnableAxisXScrolling property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

winforms-heatmap-bind-to-data-source/CS/Form1.cs#L58

csharp
heatmap.EnableAxisXScrolling = true;
heatmap.EnableAxisYScrolling = true;

winforms-dashboard-custom-items-extension/CS/CustomItemExtension/CustomItems/Heatmap/HeatmapItemControlProvider.cs#L39

csharp
heatmap.Legend.Visibility = dashboardItem.Metadata.ShowLegend ? DefaultBoolean.True : DefaultBoolean.False;
heatmap.EnableAxisXZooming = heatmap.EnableAxisXScrolling = dashboardItem.Metadata.EnableZoomingXAxis;
heatmap.EnableAxisYZooming = heatmap.EnableAxisYScrolling = dashboardItem.Metadata.EnableZoomingYAxis;

winforms-dashboard-custom-items-extension/VB/CustomItemExtension/CustomItems/Heatmap/HeatmapItemControlProvider.vb#L45

vb
heatmap.Legend.Visibility = If(dashboardItem.Metadata.ShowLegend, DefaultBoolean.True, DefaultBoolean.False)
heatmap.EnableAxisXScrolling = dashboardItem.Metadata.EnableZoomingXAxis
heatmap.EnableAxisXZooming = heatmap.EnableAxisXScrolling

winforms-heatmap-bind-to-data-source/VB/Form1.vb#L37

vb
Me.heatmap.ToolTipTextPattern = "X: <b>{X}</b>" & Global.Microsoft.VisualBasic.Constants.vbLf & "Y: <b>{Y}</b>"
Me.heatmap.EnableAxisXScrolling = True
Me.heatmap.EnableAxisYScrolling = True

See Also

HeatmapControl Class

HeatmapControl Members

DevExpress.XtraCharts.Heatmap Namespace