HeatmapBorder.Visibility Property

Gets or sets the heatmap border visibility.

Namespace: DevExpress.XtraCharts.Heatmap

Assembly: DevExpress.XtraCharts.v21.2.dll

NuGet Package: DevExpress.Charts

Declaration

C#

[XtraChartsLocalizableCategory(XtraChartsCategory.Behavior)]
public DefaultBoolean Visibility { get; set; }

VB.NET

<XtraChartsLocalizableCategory(XtraChartsCategory.Behavior)>
Public Property Visibility As DefaultBoolean

Property Value

Type	Description
DefaultBoolean	true if the border is visible; otherwise, false.

Available values:

Name	Description
True	true. DefaultBoolean.True has a constant value of 0, while the standard true value corresponds to a value of 1. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
False	false. DefaultBoolean.False has a constant value of 1, while the standard false value corresponds to a value of 0. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
Default	The default behavior determined by the control’s logic.

Example

The following example shows how to configure heatmap cell label settings such as format, font, color, and so on.

Use the HeatmapControl.Label property to access label settings:

C#

using DevExpress.XtraCharts;
using DevExpress.XtraCharts.Heatmap;
using System;
using System.Drawing;
using System.Windows.Forms;

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

            HeatmapControl heatmap = new HeatmapControl();
            this.Controls.Add(heatmap);

            heatmap.Dock = DockStyle.Fill;

            HeatmapMatrixAdapter dataAdapter = new HeatmapMatrixAdapter();
            dataAdapter.XArguments = new string[] { "North", "South", "West", "East", "Central" };
            dataAdapter.YArguments = new string[] { "Components", "Clothing", "Bikes", "Accessories" };
            dataAdapter.Values = new double[,] {
                { 21.3, 50.1, 63.2, 64.4, 33.4 },
                { 32.3, 54.4, 81.3, 53.4, 54.9 },
                { 60.3, 49.1, 42.6, 48.4, 65.4 },
                { 45.3, 54.7, 70.3, 66.4, 56.6 }
            };
            heatmap.DataAdapter = dataAdapter;
            Palette palette = new Palette("Custom") { Color.White, Color.SkyBlue, Color.DarkBlue };
            RangeColorProvider colorProvider = new RangeColorProvider() { Palette = palette, ApproximateColors = true };
            colorProvider.RangeStops.Add(new Unit(0, UnitType.Percentage));
            colorProvider.RangeStops.Add(new Unit(20, UnitType.Absolute));
            colorProvider.RangeStops.Add(new Unit(40, UnitType.Absolute));
            colorProvider.RangeStops.Add(new Unit(60, UnitType.Absolute));
            colorProvider.RangeStops.Add(new Unit(90, UnitType.Absolute));
            colorProvider.RangeStops.Add(new Unit(1, UnitType.Percentage));
            dataAdapter.ColorProvider = colorProvider;

            HeatmapLabel label = heatmap.Label;
            label.Visible = true;
            label.Pattern = "{V:f0}";
            label.BackColor = Color.White;
            label.Color = Color.Black;
            label.Font = new Font("SegoeUI", 10);
            label.TextOrientation = DevExpress.XtraCharts.Heatmap.TextOrientation.Horizontal;
            label.Border.Visibility = DevExpress.Utils.DefaultBoolean.True;
            label.Border.Color = Color.DarkGray;
            label.Border.Thickness = 2;
        }
    }
}

VB.NET

Imports DevExpress.XtraCharts
Imports DevExpress.XtraCharts.Heatmap
Imports System
Imports System.Drawing
Imports System.Windows.Forms

Namespace HeatmapMatrixAdapterSample
    Public Partial Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
            Dim heatmap As HeatmapControl = New HeatmapControl()
            Me.Controls.Add(heatmap)
            heatmap.Dock = DockStyle.Fill
            Dim dataAdapter As HeatmapMatrixAdapter = New HeatmapMatrixAdapter()
            dataAdapter.XArguments = New String() {"North", "South", "West", "East", "Central"}
            dataAdapter.YArguments = New String() {"Components", "Clothing", "Bikes", "Accessories"}
            dataAdapter.Values = New Double(,) {
            {21.3, 50.1, 63.2, 64.4, 33.4},
            {32.3, 54.4, 81.3, 53.4, 54.9},
            {60.3, 49.1, 42.6, 48.4, 65.4},
            {45.3, 54.7, 70.3, 66.4, 56.6}}
            heatmap.DataAdapter = dataAdapter
            Dim palette As Palette = New Palette("Custom") From {
                System.Drawing.Color.White,
                System.Drawing.Color.SkyBlue,
                System.Drawing.Color.DarkBlue
            }
            Dim colorProvider As RangeColorProvider = New RangeColorProvider() With {
                .Palette = palette,
                .ApproximateColors = True
            }
            colorProvider.RangeStops.Add(New Unit(0, UnitType.Percentage))
            colorProvider.RangeStops.Add(New Unit(20, UnitType.Absolute))
            colorProvider.RangeStops.Add(New Unit(40, UnitType.Absolute))
            colorProvider.RangeStops.Add(New Unit(60, UnitType.Absolute))
            colorProvider.RangeStops.Add(New Unit(90, UnitType.Absolute))
            colorProvider.RangeStops.Add(New Unit(1, UnitType.Percentage))
            dataAdapter.ColorProvider = colorProvider
            Dim label As HeatmapLabel = heatmap.Label
            label.Visible = True
            label.Pattern = "{V:f0}"
            label.BackColor = System.Drawing.Color.White
            label.Color = System.Drawing.Color.Black
            label.Font = New Font("SegoeUI", 10)
            label.TextOrientation = DevExpress.XtraCharts.Heatmap.TextOrientation.Horizontal
            label.Border.Visibility = DevExpress.Utils.DefaultBoolean.True
            label.Border.Color = Color.DarkGray
            label.Border.Thickness = 2
        End Sub
    End Class
End Namespace