Class ChartLegendSettings

Inheritance
System.Object
TagHelper
EJTagHelper
ChartLegendSettings
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.EJ2.Charts
Assembly: Syncfusion.EJ2.dll
Syntax
public class ChartLegendSettings : EJTagHelper

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
[HtmlAttributeName("alignment")]
public Alignment Alignment { get; set; }
Property Value
Type Description
Alignment

Background

The background color of the legend that accepts value in hex and rgba as a valid CSS color string.

Declaration
[HtmlAttributeName("background")]
public string Background { get; set; }
Property Value
Type Description
System.String

Border

Options to customize the border of the legend.

Declaration
[HtmlAttributeName("border")]
public ChartLegendBorder Border { get; set; }
Property Value
Type Description
ChartLegendBorder

ContainerPadding

Options to customize left, right, top and bottom padding for legend container of the chart.

Declaration
[HtmlAttributeName("containerPadding")]
public object ContainerPadding { get; set; }
Property Value
Type Description
System.Object

ContentTemplate

To get or set value for ContentTemplate.

Declaration
public MvcTemplate<object> ContentTemplate { get; set; }
Property Value
Type Description
MvcTemplate<System.Object>

Description

Description for legends.

Declaration
[HtmlAttributeName("description")]
public string Description { get; set; }
Property Value
Type Description
System.String

EnablePages

If set to true, legend will be visible using pages.

Declaration
[HtmlAttributeName("enablePages")]
public bool EnablePages { get; set; }
Property Value
Type Description
System.Boolean

Height

The height of the legend in pixels.

Declaration
[HtmlAttributeName("height")]
public string Height { get; set; }
Property Value
Type Description
System.String

IsComplex

Declaration
protected override bool IsComplex { get; }
Property Value
Type Description
System.Boolean
Overrides

IsInversed

If set to true, legend will be Reversed.

Declaration
[HtmlAttributeName("isInversed")]
public bool IsInversed { get; set; }
Property Value
Type Description
System.Boolean

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
[HtmlAttributeName("location")]
public ChartLocation Location { get; set; }
Property Value
Type Description
ChartLocation

Margin

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

Declaration
[HtmlAttributeName("margin")]
public object Margin { get; set; }
Property Value
Type Description
System.Object

MaximumTitleWidth

maximum width for the legend title.

Declaration
[HtmlAttributeName("maximumTitleWidth")]
public double MaximumTitleWidth { get; set; }
Property Value
Type Description
System.Double

Mode

Mode of legend items Series: Legend items generated based on series count. Point: Legend items generated based on unique data points. Range: Legend items generated based on range color mapping property. Gradient: Single linear bar generated based on range color mapping property. This property is applicable for chart component only.

Declaration
[HtmlAttributeName("mode")]
public LegendMode Mode { get; set; }
Property Value
Type Description
LegendMode

Opacity

Opacity of the legend.

Declaration
[HtmlAttributeName("opacity")]
public double Opacity { get; set; }
Property Value
Type Description
System.Double

Padding

Option to customize the padding between legend items.

Declaration
[HtmlAttributeName("padding")]
public double Padding { get; set; }
Property Value
Type Description
System.Double

ParentPropertyName

Declaration
protected override string ParentPropertyName { get; }
Property Value
Type Description
System.String
Overrides

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
[HtmlAttributeName("position")]
public LegendPosition Position { get; set; }
Property Value
Type Description
LegendPosition

ShapeHeight

Shape height of the legend in pixels.

Declaration
[HtmlAttributeName("shapeHeight")]
public double ShapeHeight { get; set; }
Property Value
Type Description
System.Double

ShapePadding

Padding between the legend shape and text.

Declaration
[HtmlAttributeName("shapePadding")]
public double ShapePadding { get; set; }
Property Value
Type Description
System.Double

ShapeWidth

Shape width of the legend in pixels.

Declaration
[HtmlAttributeName("shapeWidth")]
public double ShapeWidth { get; set; }
Property Value
Type Description
System.Double

TabIndex

TabIndex value for the legend.

Declaration
[HtmlAttributeName("tabIndex")]
public double TabIndex { get; set; }
Property Value
Type Description
System.Double

TextStyle

Options to customize the legend text.

Declaration
[HtmlAttributeName("textStyle")]
public ChartLegendTextStyle TextStyle { get; set; }
Property Value
Type Description
ChartLegendTextStyle

Title

Title for legends.

Declaration
[HtmlAttributeName("title")]
public string Title { get; set; }
Property Value
Type Description
System.String

TitlePosition

legend title position

Declaration
[HtmlAttributeName("titlePosition")]
public LegendTitlePosition TitlePosition { get; set; }
Property Value
Type Description
LegendTitlePosition

TitleStyle

Options to customize the legend title.

Declaration
[HtmlAttributeName("titleStyle")]
public ChartLegendTitleStyle TitleStyle { get; set; }
Property Value
Type Description
ChartLegendTitleStyle

ToggleVisibility

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

Declaration
[HtmlAttributeName("toggleVisibility")]
public bool ToggleVisibility { get; set; }
Property Value
Type Description
System.Boolean

Visible

If set to true, legend will be visible.

Declaration
[HtmlAttributeName("visible")]
public bool Visible { get; set; }
Property Value
Type Description
System.Boolean

Width

The width of the legend in pixels.

Declaration
[HtmlAttributeName("width")]
public string Width { get; set; }
Property Value
Type Description
System.String