Class ChartMultiLevelLabel

Provides options to customize the multi-level label of the axis in a chart.

Inheritance
System.Object
ChartSubComponent
ChartMultiLevelLabel
Inherited Members
Namespace: Syncfusion.Blazor.Charts
Assembly: Syncfusion.Blazor.dll
Syntax
public class ChartMultiLevelLabel : ChartSubComponent, ISubcomponentTracker

Constructors

ChartMultiLevelLabel()

Declaration
public ChartMultiLevelLabel()

Properties

Alignment

Gets or sets the alignment of the multi-level labels in the chart.

Declaration
public Alignment Alignment { get; set; }
Property Value
Type Description
Alignment

One of the Alignment enumeration values that specifies the positioning of the multi-level labels. The options include:

  • Near: Aligns labels at the start of the multi-level label rectangle (left for horizontal orientation, top for vertical orientation).
  • Center: Centers the multi-level labels within the rectangle.
  • Far: Aligns labels at the end of the multi-level label rectangle (right for horizontal orientation, bottom for vertical orientation). The default value is Alignment.Center.
Remarks

This property determines how the multi-level labels are positioned relative to their placeholder rectangle, providing flexibility in label presentation. Proper alignment can enhance the readability and visual appeal of chart data.

Border

Gets or sets an instance of ChartAxisMultiLevelLabelBorder that specifies the border settings for multi-level labels.

Declaration
public ChartAxisMultiLevelLabelBorder Border { get; set; }
Property Value
Type Description
ChartAxisMultiLevelLabelBorder

An instance of ChartAxisMultiLevelLabelBorder.
Remarks

The Width, Color, and Type of the border for multi-level labels can be customized using this property.

Categories

Gets or sets a list of ChartCategory representing the categories for multi-level labels.

Declaration
public List<ChartCategory> Categories { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ChartCategory>

A list of ChartCategory.
Remarks

The Start, End, Text, and MaximumTextWidth of multilevel labels can be customized using the Categories which accepts the collections of ChartCategory.

Overflow

Gets or sets the text overflow behavior for multi-level labels.

Declaration
public TextOverflow Overflow { get; set; }
Property Value
Type Description
TextOverflow

One of the TextOverflow enumeration values specifying text overflow options. Options include:

  • TextOverflow.Trim: Trims text exceeding defined margins.
  • TextOverflow.Wrap: Wraps text exceeding defined margins.
  • TextOverflow.None: Displays text without modification.
    The default value is TextOverflow.Wrap.
Remarks

This property controls how multilevel label text is displayed when space is constrained, allowing for trimming, wrapping, or full display.

TextStyle

Gets or sets an instance of ChartAxisMultiLevelLabelTextStyle that controls the customization of the multilevel label text.

Declaration
public ChartAxisMultiLevelLabelTextStyle TextStyle { get; set; }
Property Value
Type Description
ChartAxisMultiLevelLabelTextStyle

An instance of ChartAxisMultiLevelLabelTextStyle.
Remarks

This property can be used to customize the color, and font-properties of the multilevel label text.

Methods

OnInitialized()

Declaration
protected override void OnInitialized()