Class Chart3DLegendSettings

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

Chart3DLegendSettings

Namespace: Syncfusion.EJ2.Charts

Assembly: Syncfusion.EJ2.dll

Syntax

public class Chart3DLegendSettings : EJTagHelper

Constructors

Chart3DLegendSettings()

Declaration

public Chart3DLegendSettings()

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	The default value is Syncfusion.EJ2.Charts.Alignment.Center

Background

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

Declaration

public string Background { get; set; }

Property Value

Type	Description
System.String	The default value is "transparent"

Border

Options to customize the border of the legend.

Declaration

public Chart3DLegendBorder Border { get; set; }

Property Value

Type	Description
Chart3DLegendBorder	The default value is null

ContainerPadding

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

Declaration

public Chart3DContainerPadding ContainerPadding { get; set; }

Property Value

Type	Description
Chart3DContainerPadding	The default value is null

ContentTemplate

To get or set value for ContentTemplate.

Declaration

public MvcTemplate<object> ContentTemplate { get; set; }

Property Value

Type
Syncfusion.EJ2.MvcTemplate<System.Object>

Description

Description for legends.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String	The default value is null

EnableHighlight

If set to true, the series get highlighted, while hovering the legend.

Declaration

public bool EnableHighlight { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnablePages

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

Declaration

public bool EnablePages { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

Height

The height of the legend in pixels.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String	The default value is null

IsInversed

If isInversed set to true, then it inverses legend item content (image and text).

Declaration

public bool IsInversed { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

ItemPadding

Option to customize the padding between legend items.

Declaration

public double ItemPadding { get; set; }

Property Value

Type	Description
System.Double	The default value is Double.NaN

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 Chart3DLegendLocation Location { get; set; }

Property Value

Type	Description
Chart3DLegendLocation	The default value is null

Margin

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

Declaration

public Chart3DLegendMargin Margin { get; set; }

Property Value

Type	Description
Chart3DLegendMargin	The default value is null

MaximumLabelWidth

Maximum label width for the legend text.

Declaration

public double MaximumLabelWidth { get; set; }

Property Value

Type	Description
System.Double	The default value is Double.NaN

MaximumTitleWidth

maximum width for the legend title.

Declaration

public double MaximumTitleWidth { get; set; }

Property Value

Type	Description
System.Double	The default value is 100

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

public Chart3DLegendMode Mode { get; set; }

Property Value

Type	Description
Chart3DLegendMode	The default value is null

Opacity

Opacity of the legend.

Declaration

public double Opacity { get; set; }

Property Value

Type	Description
System.Double	The default value is 1

Padding

Option to customize the padding around the legend items.

Declaration

public double Padding { get; set; }

Property Value

Type	Description
System.Double	The default value is 8

Position

Position of the legend in the chart. Available options include: Auto: Places the legend based on the 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	The default value is LegendPosition.Auto

Reverse

If reverse is set to true, it reverses the order of legend items.

Declaration

public bool Reverse { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

ShapeHeight

Shape height of the legend in pixels.

Declaration

public double ShapeHeight { get; set; }

Property Value

Type	Description
System.Double	The default value is 10

ShapePadding

Padding between the legend shape and text.

Declaration

public double ShapePadding { get; set; }

Property Value

Type	Description
System.Double	The default value is 8

ShapeWidth

Shape width of the legend in pixels.

Declaration

public double ShapeWidth { get; set; }

Property Value

Type	Description
System.Double	The default value is 10

TabIndex

TabIndex value for the legend.

Declaration

public double TabIndex { get; set; }

Property Value

Type	Description
System.Double	The default value is 3

TextOverflow

Defines the text overflow behavior to employ when the individual legend text overflows Clip - Specifies the text is clipped and not accessible. Ellipsis - Specifies an ellipsis (“...”) to the clipped text.

Declaration

public LabelOverflow TextOverflow { get; set; }

Property Value

Type	Description
LabelOverflow	The default value is LabelOverflow.Ellipsis

TextStyle

Options to customize the legend text.

Declaration

public Chart3DLegendTextStyle TextStyle { get; set; }

Property Value

Type	Description
Chart3DLegendTextStyle	The default value is null

TextWrap

Defines the text wrap behavior to employ when the individual legend text overflows Normal - Specifies to break words only at allowed break points. Wrap - Specifies to break a word once it is too long to fit on a line by itself. AnyWhere - Specifies to break a word at any point if there are no otherwise-acceptable break points in the line.

Declaration

public TextWrap TextWrap { get; set; }

Property Value

Type	Description
TextWrap	The default value is TextWrap.Normal

Title

Title for legends.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String	The default value is null

TitlePosition

legend title position.

Declaration

public LegendTitlePosition TitlePosition { get; set; }

Property Value

Type	Description
LegendTitlePosition	The default value is LegendTitlePosition.Top

TitleStyle

Options to customize the legend title.

Declaration

public Chart3DLegendTitleStyle TitleStyle { get; set; }

Property Value

Type	Description
Chart3DLegendTitleStyle	The default value is null

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	The default value is true

Visible

If set to true, the legend will be displayed for the chart.

Declaration

public bool Visible { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

Width

The width of the legend in pixels.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	The default value is null