WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ChartLegend - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class ChartLegend

    Represents the legend for smith chart.

    Inheritance
    System.Object
    ChartLegend
    Implements
    System.IDisposable
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.WinForms.SmithChart
    Assembly: Syncfusion.SfSmithChart.WinForms.dll
    Syntax
    public class ChartLegend : IDisposable

    Constructors

    ChartLegend(SfSmithChart)

    Initializes a new instance of the ChartLegend class.

    Declaration
    public ChartLegend(SfSmithChart chart)
    Parameters
    Type Name Description
    SfSmithChart chart

    smith chart instance

    Properties

    Alignment

    Gets or sets the alignment value that represents legend panel position in chart.

    Declaration
    public StringAlignment Alignment { get; set; }
    Property Value
    Type Description
    System.Drawing.StringAlignment

    BorderVisible

    Gets or sets a value indicating whether the legend border is visible or not.

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

    DockPosition

    Gets or sets the dock style for legend placement in the smith chart.

    Declaration
    public ChartDockPosition DockPosition { get; set; }
    Property Value
    Type Description
    ChartDockPosition

    Height

    Gets or sets value that represents arrange height of legend layout.

    Declaration
    public int Height { get; set; }
    Property Value
    Type Description
    System.Int32

    IconHeight

    Gets or sets the integer value that represents the icon's height.

    Declaration
    public int IconHeight { get; set; }
    Property Value
    Type Description
    System.Int32

    IconType

    Gets or sets the legend icon type.

    Declaration
    public SmithChartLegendIconType IconType { get; set; }
    Property Value
    Type Description
    SmithChartLegendIconType

    IconWidth

    Gets or sets integer value that represents icon's width.

    Declaration
    public int IconWidth { get; set; }
    Property Value
    Type Description
    System.Int32

    ItemSpacing

    Gets or sets spacing for the legend items.

    Declaration
    public int ItemSpacing { get; set; }
    Property Value
    Type Description
    System.Int32

    OffsetX

    Gets or sets integer value that represents the floating x position of legend.

    Declaration
    public int OffsetX { get; set; }
    Property Value
    Type Description
    System.Int32

    OffsetY

    Gets or sets the integer value that represents the the floating y position of legend.

    Declaration
    public int OffsetY { get; set; }
    Property Value
    Type Description
    System.Int32

    Spacing

    Gets or sets spacing between legend border and its items.

    Declaration
    public int Spacing { get; set; }
    Property Value
    Type Description
    System.Int32

    Style

    Gets or sets the style for customizing legends.

    Declaration
    public LegendStyle Style { get; set; }
    Property Value
    Type Description
    LegendStyle

    ToggleSeriesVisible

    Gets or sets a value indicating whether series is visible or not based on the toggle state of legend items.

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

    Visible

    Gets or sets a value indicating whether legend is visible or not.

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

    Width

    Gets or sets value that represents arrange width of legend layout.

    Declaration
    public int Width { get; set; }
    Property Value
    Type Description
    System.Int32

    WrapItems

    Gets or sets a value indicating whether to wrap legend items or not.

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

    Methods

    Dispose()

    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

    Declaration
    public void Dispose()

    Implements

    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved