Class ChartLegend

Telerik UI ChartLegend.

Inheritance
System.Object
Telerik.Generated.Blazor.Components.DataVizChildComponent
ChartLegend
Namespace: Telerik.Blazor.Components
Assembly: Telerik.Blazor.dll

Syntax

public class ChartLegend : DataVizChildComponent, IDisposable

Constructors

ChartLegend()

Declaration
public ChartLegend()

Properties

Align

Specifies the legend align.

Declaration
public Nullable<ChartLegendAlign> Align { get; set; }
Property Value
System.Nullable<ChartLegendAlign>

Background

The background color of the legend. Accepts a valid CSS color string, including hex and rgb.

Declaration
public string Background { get; set; }
Property Value
System.String

ChildContent

Declaration
public RenderFragment ChildContent { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment

Height

The legend height when the legend.orientation is set to "vertical".

Declaration
public Nullable<double> Height { get; set; }
Property Value
System.Nullable<System.Double>

OffsetX

The X offset of the chart legend. The offset is relative to the default position of the legend. For instance, a value of 20 will move the legend 20 pixels to the right of its initial position. A negative value will move the legend to the left of its current position.

Declaration
public Nullable<double> OffsetX { get; set; }
Property Value
System.Nullable<System.Double>

OffsetY

The Y offset of the chart legend. The offset is relative to the current position of the legend. For instance, a value of 20 will move the legend 20 pixels down from its initial position. A negative value will move the legend upwards from its current position.

Declaration
public Nullable<double> OffsetY { get; set; }
Property Value
System.Nullable<System.Double>

Orientation

Specifies the legend orientation.

Declaration
public Nullable<ChartLegendOrientation> Orientation { get; set; }
Property Value
System.Nullable<ChartLegendOrientation>

Position

Specifies the legend position.

Declaration
public Nullable<ChartLegendPosition> Position { get; set; }
Property Value
System.Nullable<ChartLegendPosition>

Reverse

If set to true the legend items will be reversed.Available in versions 2013.3.1306 and later.

Declaration
public Nullable<bool> Reverse { get; set; }
Property Value
System.Nullable<System.Boolean>

Spacing

The spacing between the labels in pixels when the legend.orientation is "horizontal".

Declaration
public Nullable<double> Spacing { get; set; }
Property Value
System.Nullable<System.Double>

Visible

If set to true the chart will display the legend. By default the chart legend is visible.

Declaration
public Nullable<bool> Visible { get; set; }
Property Value
System.Nullable<System.Boolean>

Width

The legend width when the legend.orientation is set to "horizontal".

Declaration
public Nullable<double> Width { get; set; }
Property Value
System.Nullable<System.Double>

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

OnAfterRender(Boolean)

Declaration
protected override void OnAfterRender(bool firstRender)
Parameters
System.Boolean firstRender

OnInitialized()

Declaration
protected override void OnInitialized()
Overrides
Telerik.Generated.Blazor.Components.DataVizChildComponent.OnInitialized()

OnParametersSet()

Declaration
protected override void OnParametersSet()

Serialize()

Declaration
public Dictionary<string, object> Serialize()
Returns
System.Collections.Generic.Dictionary<System.String, System.Object>