Web Components Data Legend

    In Ignite UI for Web Components, the IgcDataLegendComponent is highly-customizable version of the IgcLegendComponent, that shows values of series and provides many configuration properties for filtering series rows and values columns, styling and formatting values. This legend updates when moving the mouse inside of the plot area of the IgcCategoryChartComponent, IgcFinancialChartComponent, and IgcDataChartComponent. Also, it has a persistent state that remembers the last hovered point when the user's mouse pointer exits the plot area. It displays this content using a set of three type of rows (header, series, summary) and four types of columns (title, label, value, unit).

    Web Components Data Legend Rows

    The rows of the IgcDataLegendComponent include the header row, series row(s), and the summary row. The header row displays the axis label of the point that is hovered, and can be changed using the headerText property.

    EXAMPLE
    DATA
    TS
    HTML
    CSS
    Edit in:

    Like this sample? Get access to our complete Ignite UI for Web Components toolkit and start building your own apps in minutes. Download it for free.

    Header Row

    The header row displays the current label of x-axis when hovering mouse over category series and financial series. You can use headerFormatDate and headerFormatTime properties to format date and time in the IgcDataLegendComponent if the x-axis shows dates. For other types of series, the IgcDataLegendComponent does not render the header row.

    Series Row

    The series row represents each series plotted in the chart. These rows will display the legend badge, series title, actual/abbreviated value of the the series, and abbreviation symbol or unit of measurement, if specified. You can filter series rows by setting includedSeries or excludedSeries properties to a collection of series' indexes (1, 2, 3) or series' titles (Tesla, Microsoft).

    Summary Row

    Finally, there is a summary row that displays the total of all series values. The default summary title can be changed using the summaryTitleText property of the legend. Also, you can use the summaryType property to customize whether you display the Total, Min, Max, or Average of series values in the summary row.

    Web Components Data Legend Columns

    The columns of the IgcDataLegendComponent include the series title, label, value of data column, and optional unit associated with the value. Some series in the chart can have multiple columns for label, value, and units. For example, financial price series has High, Low, Open, and Close data columns which can be filtered in the IgcDataLegendComponent using the includedColumns or excludedColumns properties.

    EXAMPLE
    DATA
    TS
    HTML
    CSS
    Edit in:

    Setting values on the includedColumns and excludedColumns properties, depends on type of series and how many data columns they support. For example, you can set includedColumns property to a collection of Open and Close strings and the legend will show only open and close values for stock prices when the chart is plotting financial series. The following table lists all column names that can be use to filter columns in data legend.

    Type of Series Column Names
    Category Series Value
    Radial Series Value
    Polar Series Radius, Angle
    Bubble Series X, Y, Radius
    Scatter Series X, Y
    Range Series High, Low
    Financial Series High, Low, Open, Close, Change, TypicalPrice, Volume

    Where the TypicalPrice and percentage Change of OHLC prices are automatically calculated by financial series so you do not need to include them in your data sources.

    Title Column

    The title column displays legend badges and series titles, which come from the title property of the different IgcSeriesComponent plotted in the chart.

    Label Column

    The label column displays short name on the left side of value column, e.g. "O" for Open stock price. You can toggle visibility of this column using the labelDisplayMode property.

    Value Column

    The value column displays values of series as abbreviated text which can be formatted using the valueFormatAbbreviation property to apply the same abbreviation for all numbers by setting this property to Shared. Alternatively, a user can select other abbreviations such as Independent, Kilo, Million, etc. Precision of abbreviated values is controlled using the valueFormatMinFractions and valueFormatMaxFractions for minimum and maximum digits, respectively.

    Unit Column

    The unit column displays an abbreviation symbol on the right side of value column. The unit symbol depends on the valueFormatAbbreviation property, e.g. "M" for the Million abbreviation.

    Customizing Columns

    You can customize text displayed in the Label and Unit columns using properties that end with MemberAsLegendLabel and MemberAsLegendUnit on each series. The following table shows some possible customizations of the Label and Unit columns.

    Type of Series Series Properties
    Category Series ValueMemberAsLegendLabel="$"
    ValueMemberAsLegendUnit="M"
    Radial Series ValueMemberAsLegendLabel="Distance:"
    ValueMemberAsLegendUnit="KM"
    Polar Series RadiusMemberAsLegendLabel="Radius:"
    RadiusMemberAsLegendUnit="KM"
    AngleMemberAsLegendLabel="Angle:"
    AngleMemberAsLegendUnit="°"
    Range Series HighMemberAsLegendLabel="H:"
    HighMemberAsLegendUnit="K"
    LowMemberAsLegendLabel="L:"
    LowMemberAsLegendUnit="K"
    Financial Series OpenMemberAsLegendLabel="O:"
    OpenMemberAsLegendUnit="K"
    HighMemberAsLegendLabel="H:"
    HighMemberAsLegendUnit="K"
    LowMemberAsLegendLabel="L:"
    LowMemberAsLegendUnit="K"
    CloseMemberAsLegendLabel="C:"
    CloseMemberAsLegendUnit="K"

    Also, you can use the UnitText property on the IgcDataLegendComponent to change text displayed in all Unit columns.

    Ignite UI for Web Components | CTA Banner

    Web Components Data Legend Styling

    The IgcDataLegendComponent provides properties for styling each type of column. Each of these properties begins with Title, Label, Value, or Units. You can style the text's color, font, and margin. For example, if you wanted to set the text color of all columns, you would set the titleTextColor, labelTextColor, valueTextColor, and unitsTextColor properties. The following example demonstrates a utilization of the styling properties mentioned above:

    EXAMPLE
    DATA
    TS
    HTML
    CSS
    Edit in:

    Web Components Data Legend Value Formatting

    The IgcDataLegendComponent provides automatic abbreviation of large numbers using its valueFormatAbbreviation property. This adds a multiplier in the units column such as kilo, million, billion, etc. You can customize the number of fractional digits that are displayed by setting the valueFormatMinFractions and valueFormatMaxFractions. This will allow you to determine the minimum and maximum number of digits that appear after the decimal point, respectively. The following example demonstrates how to use those properties:

    EXAMPLE
    DATA
    TS
    HTML
    CSS
    Edit in:

    Web Components Data Legend Value Mode

    You have the ability to change the default decimal display of values within the IgcDataLegendComponent to a currency by changing the valueFormatMode property. Also, you can change the culture of the displayed currency symbol by setting the valueFormatCulture property a culture tag. For example, the following example data legend with the valueFormatCulture set to "en-GB" to display British Pounds (£) symbol:

    EXAMPLE
    DATA
    TS
    HTML
    CSS
    Edit in:

    Web Components Data Legend Grouping

    dataLegendGroup can be set, on all types of series, to a string that will categorize a group of series in Data Legend. Each group will have its own summary row displayed before another group of series is displayed: By default, DataLegend will hide names of groups, but you can display group names by setting the groupRowVisible property to true.

    EXAMPLE
    DATA
    TS
    HTML
    CSS
    Edit in:

    Web Components Data Legend Styling & Events

    Several properties are exposed including grouping portions of the legend.

    • GroupRowMargin
    • GroupTextMargin
    • groupTextColor
    • GroupTextFontSize
    • GroupTextFontFamily
    • GroupTextFontStyle
    • GroupTextFontStretch
    • GroupTextFontWeight
    • HeaderTextMargin
    • headerTextColor
    • HeaderTextFontSize
    • HeaderTextFontFamily
    • HeaderTextFontStyle
    • HeaderTextFontStretch
    • HeaderTextFontWeight

    The IgcDataLegendComponent has several events that fire when rendering their corresponding row, even during mouse interactions where the values are updating. These events are listed below with a description of what they are designed to be used for:

    • StyleGroupRow: This event fires for each group to style text displayed in group rows.
    • StyleHeaderRow: This event fires when rendering the header row.
    • StyleSeriesRow: This event fires once for each series row, which allows conditional styling of the values of the series.
    • StyleSeriesColumn: This event fires once for each series column, which allows conditional styling of the different columns for the series in the chart.
    • StyleSummaryRow: This event fires once when rendering the summary row.
    • StyleSummaryColumn: This event fires once when rendering the summary column.

    Some of the events exposes a IgcDataLegendStylingRowEventArgs parameter as its arguments, which lets you customize each item's text, text color, and the overall visibility of the row. The event arguments also expose event-specific properties. For example, since the StyleSeriesRow event fires for each series, the event arguments will return the series index and series title for the row that represents the series.

    StyleSummaryColumn and SeriesStyleColumn events expose a IgcDataLegendStylingColumnEventArgs parameter as its arguments, for customizing each field in the series. The event arguments also expose event-specific properties such as column index and value member related properies about the columns.

    EXAMPLE
    DATA
    TS
    HTML
    CSS
    Edit in:

    API References