DxChartBase.HideTooltip() Method

Hides the tooltip shown with a ShowTooltip method call.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v25.1.dll

NuGet Package: DevExpress.Blazor

Declaration

public void HideTooltip()

Remarks

Add a DxChartTooltip object to chart markup and set the DxChartTooltip.Enabled property to true to enable tooltip functionality.

Chart components allow you to change tooltip visibility in code. Call DxChart.ShowTooltip, DxPieChart.ShowTooltip, or DxPolarChart.ShowTooltip method overloads to show the tooltip for the specified series point. To hide the tooltip, call the HideTooltip() method.

The following code snippet displays custom Show Tooltip and Hide Tooltip buttons that show and hide the tooltip for the specified series point:

Razor

<DxChart Data="@SalesData" @ref="@chart">
    <DxChartLineSeries Name="2017"
                       Filter="@((SaleInfo s) => s.Date.Year == 2017)"
                       ArgumentField="@(s => s.City)"
                       ValueField="@(s => s.Amount)"
                       SummaryMethod="Enumerable.Sum" />
    <DxChartLineSeries Name="2018"
                       Filter="@((SaleInfo s) => s.Date.Year == 2018)"
                       ArgumentField="@(s => s.City)"
                       ValueField="@(s => s.Amount)"
                       SummaryMethod="Enumerable.Sum" />
    <DxChartLegend AllowToggleSeries="true" 
                   Orientation="Orientation.Vertical"
                   Position="RelativePosition.Outside"
                   HorizontalAlignment="HorizontalAlignment.Right">
        <DxChartTitle Text="Years" />
    </DxChartLegend>
    <DxChartTooltip Enabled="true" />
</DxChart>

<DxButton Text=" Show Tooltip" Click="@OnShowTooltipButtonClick" />
<DxButton Text = "Hide Tooltip" Click="@OnHideTooltipButtonClick" />

@code {
    DxChart<SaleInfo> chart;
    string seriesName = "2017";

    void OnShowTooltipButtonClick() {
        var point = SalesData.Where(x => x.City == "Denver").FirstOrDefault();
        if(point != null)
            // Pass the series name as a parameter
            chart.ShowTooltip(point, seriesName);
            // Pass the series index (order) as a parameter
            chart.ShowTooltip(point, 0);
    }

    void OnHideTooltipButtonClick() {
        chart.HideTooltip();
    }

    IEnumerable<SaleInfo> SalesData;
    protected override async Task OnInitializedAsync() {
        SalesData = await Sales.GetSalesAsync();
    }
}

SalesData.cs

public class Sales {
    static IList<SaleInfo> dataSource;

    public class SaleInfo {
        public int OrderId { get; set; }
        public string Region { get; set; }
        public string Country { get; set; }
        public string City { get; set; }
        public int Amount { get; set; }
        public DateTime Date { get; set; }
    }
    static Sales() {
        CreateDataSource();
    }

    public static Task<IQueryable<SaleInfo>> GetSalesAsync() {
        return Task.FromResult(dataSource.AsQueryable());
    }

    static void CreateDataSource() {
        dataSource = new List<SaleInfo> {
            new SaleInfo {
                OrderId = 10248,
                Region = "North America",
                Country = "United States",
                City = "New York",
                Amount = 1740,
                Date = DateTime.Parse("2017/01/06")
            },
            new SaleInfo {
                OrderId = 10249,
                Region = "North America",
                Country = "United States",
                City = "Los Angeles",
                Amount = 850,
                Date = DateTime.Parse("2017/01/13")
            },
            new SaleInfo {
                OrderId = 10250,
                Region = "North America",
                Country = "United States",
                City = "Denver",
                Amount = 2235,
                Date = DateTime.Parse("2017/01/07")
            },
            new SaleInfo {
                OrderId = 10251,
                Region = "North America",
                Country = "Canada",
                City = "Vancouver",
                Amount = 1965,
                Date = DateTime.Parse("2017/01/03")
            },
            new SaleInfo {
                OrderId = 10252,
                Region = "North America",
                Country = "Canada",
                City = "Edmonton",
                Amount = 880,
                Date = DateTime.Parse("2017/01/10")
            },
            new SaleInfo {
                OrderId = 10253,
                Region = "South America",
                Country = "Brazil",
                City = "Rio de Janeiro",
                Amount = 5260,
                Date = DateTime.Parse("2017/01/17")
            },
            new SaleInfo {
                OrderId = 10254,
                Region = "South America",
                Country = "Argentina",
                City = "Buenos Aires",
                Amount = 2790,
                Date = DateTime.Parse("2017/01/21")
            },
            new SaleInfo {
                OrderId = 10255,
                Region = "South America",
                Country = "Paraguay",
                City = "Asuncion",
                Amount = 3140,
                Date = DateTime.Parse("2017/01/01")
            },
            new SaleInfo {
                OrderId = 10256,
                Region = "Europe",
                Country = "United Kingdom",
                City = "London",
                Amount = 6175,
                Date = DateTime.Parse("2017/01/24")
            },
            new SaleInfo {
                OrderId = 10257,
                Region = "Europe",
                Country = "Germany",
                City = "Berlin",
                Amount = 4575,
                Date = DateTime.Parse("2017/01/11")
            },
            new SaleInfo {
                OrderId = 10517,
                Region = "North America",
                Country = "United States",
                City = "New York",
                Amount = 7710,
                Date = DateTime.Parse("2018/01/18")
            },
            new SaleInfo {
                OrderId = 10518,
                Region = "North America",
                Country = "United States",
                City = "Los Angeles",
                Amount = 7975,
                Date = DateTime.Parse("2018/01/10")
            },
            new SaleInfo {
                OrderId = 10519,
                Region = "North America",
                Country = "United States",
                City = "Denver",
                Amount = 3285,
                Date = DateTime.Parse("2018/01/13")
            },
            new SaleInfo {
                OrderId = 10520,
                Region = "North America",
                Country = "Canada",
                City = "Vancouver",
                Amount = 2580,
                Date = DateTime.Parse("2018/01/22")
            },
            new SaleInfo {
                OrderId = 10521,
                Region = "North America",
                Country = "Canada",
                City = "Edmonton",
                Amount = 2160,
                Date = DateTime.Parse("2018/01/26")
            },
            new SaleInfo {
                OrderId = 10522,
                Region = "South America",
                Country = "Brazil",
                City = "Rio de Janeiro",
                Amount = 1100,
                Date = DateTime.Parse("2018/01/25")
            },
            new SaleInfo {
                OrderId = 10523,
                Region = "South America",
                Country = "Argentina",
                City = "Buenos Aires",
                Amount = 4425,
                Date = DateTime.Parse("2018/01/21")
            },
            new SaleInfo {
                OrderId = 10524,
                Region = "South America",
                Country = "Paraguay",
                City = "Asuncion",
                Amount = 1360,
                Date = DateTime.Parse("2018/01/22")
            },
            new SaleInfo {
                OrderId = 10525,
                Region = "Europe",
                Country = "United Kingdom",
                City = "London",
                Amount = 3250,
                Date = DateTime.Parse("2018/01/14")
            },
            new SaleInfo {
                OrderId = 10526,
                Region = "Europe",
                Country = "Germany",
                City = "Berlin",
                Amount = 5550,
                Date = DateTime.Parse("2018/01/21")
            },
        };
    }
}