Class ChartLegendSettingsBuilder
Inheritance
System.Object
ChartLegendSettingsBuilder
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()
Assembly: Syncfusion.EJ2.dll
Syntax
public class ChartLegendSettingsBuilder : ControlBuilder
Constructors
ChartLegendSettingsBuilder()
Declaration
public ChartLegendSettingsBuilder()
ChartLegendSettingsBuilder(ChartLegendSettings)
Declaration
public ChartLegendSettingsBuilder(ChartLegendSettings 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 ChartLegendSettingsBuilder 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 ChartLegendSettingsBuilder Background(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Border(ChartLegendBorder)
Options to customize the border of the legend.
Declaration
public ChartLegendSettingsBuilder Border(ChartLegendBorder value)
Parameters
Returns
Border(Action<ChartBorderBuilder>)
Declaration
public ChartLegendSettingsBuilder Border(Action<ChartBorderBuilder> border)
Parameters
Returns
ContainerPadding(Object)
Options to customize left, right, top and bottom padding for legend container of the chart.
Declaration
public ChartLegendSettingsBuilder ContainerPadding(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Description(String)
Declaration
public ChartLegendSettingsBuilder Description(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
EnablePages(Boolean)
If set to true, legend will be visible using pages.
Declaration
public ChartLegendSettingsBuilder EnablePages(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Height(String)
The height of the legend in pixels.
Declaration
public ChartLegendSettingsBuilder 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 ChartLegendSettingsBuilder IsInversed(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Location(ChartLocation)
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 ChartLegendSettingsBuilder Location(ChartLocation value)
Parameters
Returns
Location(Action<ChartLocationBuilder>)
Declaration
public ChartLegendSettingsBuilder Location(Action<ChartLocationBuilder> location)
Parameters
Returns
Margin(Object)
Options to customize left, right, top and bottom margins of the chart.
Declaration
public ChartLegendSettingsBuilder Margin(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
MaximumLabelWidth(Double)
Maximum label width for the legend text.
Declaration
public ChartLegendSettingsBuilder MaximumLabelWidth(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
MaximumTitleWidth(Double)
maximum width for the legend title.
Declaration
public ChartLegendSettingsBuilder MaximumTitleWidth(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Mode(LegendMode)
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 ChartLegendSettingsBuilder Mode(LegendMode value)
Parameters
Returns
Opacity(Double)
Declaration
public ChartLegendSettingsBuilder Opacity(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Padding(Double)
Option to customize the padding between legend items.
Declaration
public ChartLegendSettingsBuilder Padding(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Position(LegendPosition)
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
public ChartLegendSettingsBuilder Position(LegendPosition value)
Parameters
Returns
Reverse(Boolean)
If reverse set to true, then it reverse the legend items order.
Declaration
public ChartLegendSettingsBuilder Reverse(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
ShapeHeight(Double)
Shape height of the legend in pixels.
Declaration
public ChartLegendSettingsBuilder ShapeHeight(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
ShapePadding(Double)
Padding between the legend shape and text.
Declaration
public ChartLegendSettingsBuilder ShapePadding(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
ShapeWidth(Double)
Shape width of the legend in pixels.
Declaration
public ChartLegendSettingsBuilder ShapeWidth(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
TabIndex(Double)
TabIndex value for the legend.
Declaration
public ChartLegendSettingsBuilder 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 ChartLegendSettingsBuilder TextOverflow(LabelOverflow value)
Parameters
Returns
TextStyle(ChartLegendTextStyle)
Options to customize the legend text.
Declaration
public ChartLegendSettingsBuilder TextStyle(ChartLegendTextStyle value)
Parameters
Returns
TextStyle(Action<ChartFontBuilder>)
Declaration
public ChartLegendSettingsBuilder TextStyle(Action<ChartFontBuilder> 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 ChartLegendSettingsBuilder TextWrap(TextWrap value)
Parameters
Returns
Title(String)
Declaration
public ChartLegendSettingsBuilder Title(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
TitlePosition(LegendTitlePosition)
Declaration
public ChartLegendSettingsBuilder TitlePosition(LegendTitlePosition value)
Parameters
Returns
TitleStyle(ChartLegendTitleStyle)
Options to customize the legend title.
Declaration
public ChartLegendSettingsBuilder TitleStyle(ChartLegendTitleStyle value)
Parameters
Returns
TitleStyle(Action<ChartFontBuilder>)
Declaration
public ChartLegendSettingsBuilder TitleStyle(Action<ChartFontBuilder> titleStyle)
Parameters
Returns
ToggleVisibility(Boolean)
If set to true, series' visibility collapses based on the legend visibility.
Declaration
public ChartLegendSettingsBuilder ToggleVisibility(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Visible(Boolean)
If set to true, legend will be visible.
Declaration
public ChartLegendSettingsBuilder Visible(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Width(String)
The width of the legend in pixels.
Declaration
public ChartLegendSettingsBuilder Width(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
