Skip to main content

IBreadcrumbTextProvider.GetText(Object, Object) Method

Returns text that describes drill down level that detalization of the specified point source object that belongs to the series source object provides.

Namespace: DevExpress.Xpf.Charts

Assembly: DevExpress.Xpf.Charts.v21.2.dll

Declaration

string GetText(
    object seriesSourceObj,
    object pointSourceObj
)

Parameters

Name Type Description
seriesSourceObj Object

The model object that describes a series.

pointSourceObj Object

The model object that defines a series point. This value can be null (Nothing in Visual Basic) if an end user clicks a series.

Returns

Type Description
String

The description of the detail level.

Example

View Example

This example demonstrates how to enable the Chart’s Drill Mode that allows end users to navigate between different detail levels:

 public interface INameable {
    string Name { get; }
}

public sealed class DevAVBranch: INameable {
    public string Name { get; set; }
    public List<DevAVProductCategory> Categories { get; set; }
    public double TotalIncome { get => Categories.Sum(c => c.TotalIncome); }
}


public sealed class DevAVProductCategory: INameable {
    public string Name { get; set; }
    public List<DevAVProduct> Products { get; set; }
    public double TotalIncome { get => Products.Sum(p => p.TotalIncome); }
}


public sealed class DevAVProduct: INameable {
    public string Name { get; set; }
    public List<DevAVMonthlyIncome> Sales { get; set; }
    public double TotalIncome { get => Sales.Sum(s => s.Income); }
}


public class DevAVMonthlyIncome {
    public DateTime Month { get; set; }
    public double Income { get; set; }
}

The table below lists classes and properties the code above includes:

Symbol

Description

Diagram.SeriesItemsSource

Gets or sets the collection of objects used to generate series.

HierarchicalDataAdapter

The data adapter that uses data objects with aggregation and composition relationships as data sources for different detail levels when the Chart control is in the Drill Mode.

HierarchicalDataAdapterBase.DataSource

Gets or set the collection of data source objects for the Chart in the Drill Mode.

HierarchicalDataAdapter.ChildrenSelector

Gets or sets an object that returns a child object collection from a data object on whose representation the end user clicked.

IChildrenSelector

An interface of a children selector for the HierarchicalDataAdapter.

HierarchicalDataAdapterBase.BreadcrumbTextProvider

Gets or sets the object that provides text for breadcrumb items when the Chart is in the Drill Mode.

IBreadcrumbTextProvider

An interface of a text provider for the HierarchicalDataAdapter.

Diagram.SeriesItemTemplateSelector

Gets or sets the custom logic for selecting a data template that converts a model object to a series.

Diagram.DrillDownStateChanged

Occurs when end users navigate by detail levels when the Chart is is the Drill Mode.

See Also