WPF

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SmithChartLegend - WPF API Reference | Syncfusion SfSmithChart. ">

    Show / Hide Table of Contents

    Class SmithChartLegend

    Represents legend for a SfSmithChart.

    Inheritance
    System.Object
    SmithChartLegend
    Namespace: Syncfusion.UI.Xaml.SmithChart
    Assembly: Syncfusion.SfSmithChart.WPF.dll
    Syntax
    public class SmithChartLegend : ItemsControl

    Constructors

    SmithChartLegend()

    Initializes a new instance of the SmithChartLegend class.

    Declaration
    public SmithChartLegend()

    Fields

    DockPositionProperty

    The DependencyProperty for DockPosition property.

    Declaration
    public static readonly DependencyProperty DockPositionProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    IconHeightProperty

    The DependencyProperty for IconHeight property.

    Declaration
    public static readonly DependencyProperty IconHeightProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    IconWidthProperty

    The DependencyProperty for IconWidth property.

    Declaration
    public static readonly DependencyProperty IconWidthProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    ItemMarginProperty

    The DependencyProperty for ItemMargin property.

    Declaration
    public static readonly DependencyProperty ItemMarginProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    LegendIconProperty

    The DependencyProperty for SmithChartLegendIcon property.

    Declaration
    public static readonly DependencyProperty LegendIconProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    LegendIconTemplateProperty

    The DependencyProperty for LegendIconTemplate property.

    Declaration
    public static readonly DependencyProperty LegendIconTemplateProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    OffsetXProperty

    Identifies the OffsetX dependency property. The DependencyProperty for OffsetX property.

    Declaration
    public static readonly DependencyProperty OffsetXProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    OffsetYProperty

    Identifies the OffsetX dependency property. The DependencyProperty for OffsetY property.

    Declaration
    public static readonly DependencyProperty OffsetYProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    Properties

    DockPosition

    Gets or sets the position of the legend.

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

    IconHeight

    Gets or sets height of the legend icon.

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

    IconWidth

    Gets or sets width of the legend icon.

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

    ItemMargin

    Gets or sets the margin for legend item.

    Declaration
    public Thickness ItemMargin { get; set; }
    Property Value
    Type Description
    System.Windows.Thickness

    LegendIcon

    Gets or sets the legend icon type.

    Declaration
    public SmithChartLegendIcon LegendIcon { get; set; }
    Property Value
    Type Description
    SmithChartLegendIcon

    LegendIconTemplate

    Gets or sets the custom legend icon template.

    Declaration
    public DataTemplate LegendIconTemplate { get; set; }
    Property Value
    Type Description
    System.Windows.DataTemplate

    OffsetX

    Gets or sets the x-axis value of the left edge of ChartLegend relative to Chart.

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

    The OffsetX.

    OffsetY

    Gets or sets the y-axis value of the top edge of ChartLegend relative to Chart.

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

    The OffsetY.

    Methods

    OnMouseDown(MouseButtonEventArgs)

    Called when the mouse button pressed on the SmithChartLegendItem.

    Declaration
    protected override void OnMouseDown(MouseButtonEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.MouseButtonEventArgs e

    Event args.

    OnMouseLeave(MouseEventArgs)

    Called when the Mouse leave from the chart legend.

    Declaration
    protected override void OnMouseLeave(MouseEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.MouseEventArgs e

    Event args.

    OnMouseMove(MouseEventArgs)

    Called when the mouse moved on the SmithChartLegend

    Declaration
    protected override void OnMouseMove(MouseEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.MouseEventArgs e

    Event args.

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