menu

ASP.NET Core - EJ2

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class AccumulationChartLegendSettingsBuilder - API Reference

    Show / Hide Table of Contents

    Class AccumulationChartLegendSettingsBuilder

    Inheritance
    System.Object
    ControlBuilder
    AccumulationChartLegendSettingsBuilder
    Inherited Members
    ControlBuilder.Output
    ControlBuilder.Context
    Namespace: Syncfusion.EJ2.Charts
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class AccumulationChartLegendSettingsBuilder : ControlBuilder

    Constructors

    AccumulationChartLegendSettingsBuilder()

    Declaration
    public AccumulationChartLegendSettingsBuilder()

    AccumulationChartLegendSettingsBuilder(AccumulationChartLegendSettings)

    Declaration
    public AccumulationChartLegendSettingsBuilder(AccumulationChartLegendSettings model)
    Parameters
    Type Name Description
    AccumulationChartLegendSettings model

    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 AccumulationChartLegendSettingsBuilder Alignment(Alignment value)
    Parameters
    Type Name Description
    Alignment value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    Background(String)

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

    Declaration
    public AccumulationChartLegendSettingsBuilder Background(string value)
    Parameters
    Type Name Description
    System.String value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    Border(AccumulationChartBorder)

    Options to customize the border of the legend.

    Declaration
    public AccumulationChartLegendSettingsBuilder Border(AccumulationChartBorder value)
    Parameters
    Type Name Description
    AccumulationChartBorder value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    Border(Action<AccumulationChartBorderBuilder>)

    Declaration
    public AccumulationChartLegendSettingsBuilder Border(Action<AccumulationChartBorderBuilder> border)
    Parameters
    Type Name Description
    System.Action<AccumulationChartBorderBuilder> border
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    ContainerPadding(Object)

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

    Declaration
    public AccumulationChartLegendSettingsBuilder ContainerPadding(object value)
    Parameters
    Type Name Description
    System.Object value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    Description(String)

    Description for legends.

    Declaration
    public AccumulationChartLegendSettingsBuilder Description(string value)
    Parameters
    Type Name Description
    System.String value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    EnableHighlight(Boolean)

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

    Declaration
    public AccumulationChartLegendSettingsBuilder EnableHighlight(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    EnablePages(Boolean)

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

    Declaration
    public AccumulationChartLegendSettingsBuilder EnablePages(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    Height(String)

    The height of the legend in pixels.

    Declaration
    public AccumulationChartLegendSettingsBuilder Height(string value)
    Parameters
    Type Name Description
    System.String value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    IsInversed(Boolean)

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

    Declaration
    public AccumulationChartLegendSettingsBuilder IsInversed(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    ItemPadding(Double)

    Option to customize the padding between legend items.

    Declaration
    public AccumulationChartLegendSettingsBuilder ItemPadding(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    Location(AccumulationChartLocation)

    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 AccumulationChartLegendSettingsBuilder Location(AccumulationChartLocation value)
    Parameters
    Type Name Description
    AccumulationChartLocation value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    Location(Action<AccumulationChartLocationBuilder>)

    Declaration
    public AccumulationChartLegendSettingsBuilder Location(Action<AccumulationChartLocationBuilder> location)
    Parameters
    Type Name Description
    System.Action<AccumulationChartLocationBuilder> location
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    Margin(Object)

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

    Declaration
    public AccumulationChartLegendSettingsBuilder Margin(object value)
    Parameters
    Type Name Description
    System.Object value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    MaximumLabelWidth(Double)

    Maximum label width for the legend text.

    Declaration
    public AccumulationChartLegendSettingsBuilder MaximumLabelWidth(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    MaximumTitleWidth(Double)

    maximum width for the legend title.

    Declaration
    public AccumulationChartLegendSettingsBuilder MaximumTitleWidth(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    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 AccumulationChartLegendSettingsBuilder Mode(LegendMode value)
    Parameters
    Type Name Description
    LegendMode value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    Opacity(Double)

    Opacity of the legend.

    Declaration
    public AccumulationChartLegendSettingsBuilder Opacity(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    Padding(Double)

    Option to customize the padding around the legend items.

    Declaration
    public AccumulationChartLegendSettingsBuilder Padding(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    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 AccumulationChartLegendSettingsBuilder Position(LegendPosition value)
    Parameters
    Type Name Description
    LegendPosition value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    Reverse(Boolean)

    If reverse set to true, then it reverse the legend items order.

    Declaration
    public AccumulationChartLegendSettingsBuilder Reverse(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    ShapeHeight(Double)

    Shape height of the legend in pixels.

    Declaration
    public AccumulationChartLegendSettingsBuilder ShapeHeight(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    ShapePadding(Double)

    Padding between the legend shape and text.

    Declaration
    public AccumulationChartLegendSettingsBuilder ShapePadding(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    ShapeWidth(Double)

    Shape width of the legend in pixels.

    Declaration
    public AccumulationChartLegendSettingsBuilder ShapeWidth(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    TabIndex(Double)

    TabIndex value for the legend.

    Declaration
    public AccumulationChartLegendSettingsBuilder TabIndex(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    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 AccumulationChartLegendSettingsBuilder TextOverflow(LabelOverflow value)
    Parameters
    Type Name Description
    LabelOverflow value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    TextStyle(AccumulationChartFont)

    Options to customize the legend text.

    Declaration
    public AccumulationChartLegendSettingsBuilder TextStyle(AccumulationChartFont value)
    Parameters
    Type Name Description
    AccumulationChartFont value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    TextStyle(Action<AccumulationChartFontBuilder>)

    Declaration
    public AccumulationChartLegendSettingsBuilder TextStyle(Action<AccumulationChartFontBuilder> textStyle)
    Parameters
    Type Name Description
    System.Action<AccumulationChartFontBuilder> textStyle
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    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 AccumulationChartLegendSettingsBuilder TextWrap(TextWrap value)
    Parameters
    Type Name Description
    TextWrap value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    Title(String)

    Title for legends.

    Declaration
    public AccumulationChartLegendSettingsBuilder Title(string value)
    Parameters
    Type Name Description
    System.String value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    TitlePosition(LegendTitlePosition)

    legend title position.

    Declaration
    public AccumulationChartLegendSettingsBuilder TitlePosition(LegendTitlePosition value)
    Parameters
    Type Name Description
    LegendTitlePosition value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    TitleStyle(AccumulationChartFont)

    Options to customize the legend title.

    Declaration
    public AccumulationChartLegendSettingsBuilder TitleStyle(AccumulationChartFont value)
    Parameters
    Type Name Description
    AccumulationChartFont value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    TitleStyle(Action<AccumulationChartFontBuilder>)

    Declaration
    public AccumulationChartLegendSettingsBuilder TitleStyle(Action<AccumulationChartFontBuilder> titleStyle)
    Parameters
    Type Name Description
    System.Action<AccumulationChartFontBuilder> titleStyle
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    ToggleVisibility(Boolean)

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

    Declaration
    public AccumulationChartLegendSettingsBuilder ToggleVisibility(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    Visible(Boolean)

    If set to true, legend will be visible.

    Declaration
    public AccumulationChartLegendSettingsBuilder Visible(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder

    Width(String)

    The width of the legend in pixels.

    Declaration
    public AccumulationChartLegendSettingsBuilder Width(string value)
    Parameters
    Type Name Description
    System.String value
    Returns
    Type Description
    AccumulationChartLegendSettingsBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved