Blazor

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ChartLegendSettings

    Show / Hide Table of Contents

    Class ChartLegendSettings

    Inheritance
    System.Object
    ChartSubComponent
    ChartLegendSettings
    Implements
    ILegendBase
    Inherited Members
    ChartSubComponent.PopSubcomponent()
    ChartSubComponent.PushSubcomponent()
    ChartSubComponent.OnParametersSet()
    ChartSubComponent.Dispose(Boolean)
    ChartSubComponent.BuildRenderTree(RenderTreeBuilder)
    ChartSubComponent.ChildContent
    Namespace: Syncfusion.Blazor.Charts
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class ChartLegendSettings : ChartSubComponent, ISubcomponentTracker, ILegendBase

    Constructors

    ChartLegendSettings()

    Declaration
    public ChartLegendSettings()

    Properties

    Alignment

    Legend in chart can be aligned as follows: Near: Aligns the legend to the left of the chart. Center: Aligns the legend to the center of the chart. Far: Aligns the legend to the right of the chart.

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

    Background

    The background of the chart legend area.

    Declaration
    public string Background { get; set; }
    Property Value
    Type Description
    System.String

    Border

    Options to customize the border of the legend.

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

    Description

    Description for legends.

    Declaration
    public string Description { get; set; }
    Property Value
    Type Description
    System.String

    EnableHighlight

    Enabling the highlight options.

    Declaration
    public bool EnableHighlight { get; set; }
    Property Value
    Type Description
    System.Boolean

    Height

    Specifies the height for legend.

    Declaration
    public string Height { get; set; }
    Property Value
    Type Description
    System.String

    IsInversed

    Gets or sets whether to inverse legend item content (image and text).

    Declaration
    public bool IsInversed { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if the legend should be inversed; otherwise, false.

    ItemPadding

    Option to customize the padding between legend items.

    Declaration
    public double ItemPadding { get; set; }
    Property Value
    Type Description
    System.Double

    Location

    Specifies the location of the legend, relative to the chart. If x is 20, legend moves by 20 pixels to the right of the chart. It requires the position to be Custom.

    Declaration
    public ChartLocation Location { get; set; }
    Property Value
    Type Description
    ChartLocation

    Margin

    Options to customize left, right, top and bottom margins of the legend.

    Declaration
    public ChartLegendMargin Margin { get; set; }
    Property Value
    Type Description
    ChartLegendMargin

    MaximumLabelWidth

    Gets and sets the maximum width of the individual legend item after which they get trimmed, wrapped or clipped.

    Declaration
    public double MaximumLabelWidth { get; set; }
    Property Value
    Type Description
    System.Double

    Specifies the maximum width for the legend text. The default value is null.

    Opacity

    Options to customize left, right, top and bottom margins of the chart.

    Declaration
    public double Opacity { get; set; }
    Property Value
    Type Description
    System.Double

    Padding

    Option to customize the padding around legend collection.

    Declaration
    public double Padding { get; set; }
    Property Value
    Type Description
    System.Double

    Position

    Position of the legend in the chart are, Auto: Places the legend based on area type. Top: Displays the legend at the top of the chart. Left: Displays the legend at the left of the chart. Bottom: Displays the legend at the bottom of the chart. Right: Displays the legend at the right of the chart. Custom: Displays the legend based on the given x and y values.

    Declaration
    public LegendPosition Position { get; set; }
    Property Value
    Type Description
    LegendPosition

    Reverse

    Gets or sets whether to reverse the legend items order.

    Declaration
    public bool Reverse { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if the legend should be reverse; otherwise, false.

    ShapeHeight

    Shape height of the legend shape.

    Declaration
    public double ShapeHeight { get; set; }
    Property Value
    Type Description
    System.Double

    ShapePadding

    Padding between the legend shape and text.

    Declaration
    public double ShapePadding { get; set; }
    Property Value
    Type Description
    System.Double

    ShapeWidth

    Shape width of the legend shape.

    Declaration
    public double ShapeWidth { get; set; }
    Property Value
    Type Description
    System.Double

    TabIndex

    TabIndex value for the legend.

    Declaration
    public double TabIndex { get; set; }
    Property Value
    Type Description
    System.Double

    TextOverflow

    Gets and sets the text overflow behavior to employ when the individual legend text overflowing the legend bounds or MaximumLabelWidth

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

    One of the TextOverflow enumeration.The default value is Ellipse

    TextStyle

    Options to customize the legend text.

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

    TextWrap

    Gets and sets the text wrap behavior to employ when the individual legend text overflowing the legend bounds or MaximumLabelWidth

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

    One of the TextWrap enumeration. The default value is Normal

    ToggleVisibility

    If set to true, series' visibility collapses based on the legend visibility.

    Declaration
    public bool ToggleVisibility { get; set; }
    Property Value
    Type Description
    System.Boolean

    Visible

    Specifies the visibility of legend.

    Declaration
    public bool Visible { get; set; }
    Property Value
    Type Description
    System.Boolean

    Width

    Specifies the width for legend.

    Declaration
    public string Width { get; set; }
    Property Value
    Type Description
    System.String

    Methods

    OnInitialized()

    Declaration
    protected override void OnInitialized()

    Implements

    ILegendBase
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved