Class Chart3DLegendSettingsBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
Chart3DLegendSettingsBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class Chart3DLegendSettingsBuilder : ControlBuilder
Constructors
Chart3DLegendSettingsBuilder()
Declaration
public Chart3DLegendSettingsBuilder()
Chart3DLegendSettingsBuilder(Chart3DLegendSettings)
Declaration
public Chart3DLegendSettingsBuilder(Chart3DLegendSettings model)
Parameters
Methods
Alignment(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 Chart3DLegendSettingsBuilder Alignment(Alignment value)
Parameters
Returns
Background(String)
The background color of the legend that accepts value in hex and rgba as a valid CSS color string.
Declaration
public Chart3DLegendSettingsBuilder Background(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Border(Chart3DLegendBorder)
Options to customize the border of the legend.
Declaration
public Chart3DLegendSettingsBuilder Border(Chart3DLegendBorder value)
Parameters
Returns
Border(Action<Chart3DBorderBuilder>)
Declaration
public Chart3DLegendSettingsBuilder Border(Action<Chart3DBorderBuilder> border)
Parameters
Returns
ContainerPadding(Chart3DContainerPadding)
Options to customize left, right, top and bottom padding for legend container of the chart.
Declaration
public Chart3DLegendSettingsBuilder ContainerPadding(Chart3DContainerPadding value)
Parameters
Returns
ContainerPadding(Action<Chart3DContainerPaddingBuilder>)
Declaration
public Chart3DLegendSettingsBuilder ContainerPadding(Action<Chart3DContainerPaddingBuilder> containerPadding)
Parameters
Returns
Description(String)
Declaration
public Chart3DLegendSettingsBuilder Description(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
EnableHighlight(Boolean)
If set to true, the series get highlighted, while hovering the legend.
Declaration
public Chart3DLegendSettingsBuilder EnableHighlight(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
EnablePages(Boolean)
If set to true, legend will be visible using pages.
Declaration
public Chart3DLegendSettingsBuilder EnablePages(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Height(String)
The height of the legend in pixels.
Declaration
public Chart3DLegendSettingsBuilder Height(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
IsInversed(Boolean)
If isInversed set to true, then it inverses legend item content (image and text).
Declaration
public Chart3DLegendSettingsBuilder IsInversed(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
ItemPadding(Double)
Option to customize the padding between legend items.
Declaration
public Chart3DLegendSettingsBuilder ItemPadding(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Location(Chart3DLegendLocation)
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 Chart3DLegendSettingsBuilder Location(Chart3DLegendLocation value)
Parameters
Returns
Location(Action<Chart3DLocationBuilder>)
Declaration
public Chart3DLegendSettingsBuilder Location(Action<Chart3DLocationBuilder> location)
Parameters
Returns
Margin(Chart3DLegendMargin)
Options to customize left, right, top and bottom margins of the chart.
Declaration
public Chart3DLegendSettingsBuilder Margin(Chart3DLegendMargin value)
Parameters
Returns
Margin(Action<Chart3DMarginBuilder>)
Declaration
public Chart3DLegendSettingsBuilder Margin(Action<Chart3DMarginBuilder> margin)
Parameters
Returns
MaximumLabelWidth(Double)
Maximum label width for the legend text.
Declaration
public Chart3DLegendSettingsBuilder MaximumLabelWidth(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
MaximumTitleWidth(Double)
maximum width for the legend title.
Declaration
public Chart3DLegendSettingsBuilder MaximumTitleWidth(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Mode(Chart3DLegendMode)
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 Chart3DLegendSettingsBuilder Mode(Chart3DLegendMode value)
Parameters
Returns
Opacity(Double)
Declaration
public Chart3DLegendSettingsBuilder Opacity(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Padding(Double)
Option to customize the padding around the legend items.
Declaration
public Chart3DLegendSettingsBuilder Padding(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Position(LegendPosition)
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 Chart3DLegendSettingsBuilder Position(LegendPosition value)
Parameters
Returns
Reverse(Boolean)
If reverse is set to true, it reverses the order of legend items.
Declaration
public Chart3DLegendSettingsBuilder Reverse(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
ShapeHeight(Double)
Shape height of the legend in pixels.
Declaration
public Chart3DLegendSettingsBuilder ShapeHeight(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
ShapePadding(Double)
Padding between the legend shape and text.
Declaration
public Chart3DLegendSettingsBuilder ShapePadding(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
ShapeWidth(Double)
Shape width of the legend in pixels.
Declaration
public Chart3DLegendSettingsBuilder ShapeWidth(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
TabIndex(Double)
TabIndex value for the legend.
Declaration
public Chart3DLegendSettingsBuilder TabIndex(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
TextOverflow(LabelOverflow)
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 Chart3DLegendSettingsBuilder TextOverflow(LabelOverflow value)
Parameters
Returns
TextStyle(Chart3DLegendTextStyle)
Options to customize the legend text.
Declaration
public Chart3DLegendSettingsBuilder TextStyle(Chart3DLegendTextStyle value)
Parameters
Returns
TextStyle(Action<Chart3DFontBuilder>)
Declaration
public Chart3DLegendSettingsBuilder TextStyle(Action<Chart3DFontBuilder> textStyle)
Parameters
Returns
TextWrap(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 Chart3DLegendSettingsBuilder TextWrap(TextWrap value)
Parameters
Returns
Title(String)
Declaration
public Chart3DLegendSettingsBuilder Title(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
TitlePosition(LegendTitlePosition)
Declaration
public Chart3DLegendSettingsBuilder TitlePosition(LegendTitlePosition value)
Parameters
Returns
TitleStyle(Chart3DLegendTitleStyle)
Options to customize the legend title.
Declaration
public Chart3DLegendSettingsBuilder TitleStyle(Chart3DLegendTitleStyle value)
Parameters
Returns
TitleStyle(Action<Chart3DFontBuilder>)
Declaration
public Chart3DLegendSettingsBuilder TitleStyle(Action<Chart3DFontBuilder> titleStyle)
Parameters
Returns
ToggleVisibility(Boolean)
If set to true, series visibility collapses based on the legend visibility.
Declaration
public Chart3DLegendSettingsBuilder ToggleVisibility(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Visible(Boolean)
If set to true, the legend will be displayed for the chart.
Declaration
public Chart3DLegendSettingsBuilder Visible(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Width(String)
The width of the legend in pixels.
Declaration
public Chart3DLegendSettingsBuilder Width(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
