Class PivotChartLegendSettings

Allow options for customizing legends with different properties such as legend visibility, height, width, position, legend padding, alignment, textStyle, border, margin, background, opacity, description, tabIndex in the pivot chart.

Inheritance

System.Object

PivotChartLegendSettings

Namespace: Syncfusion.Blazor.PivotView

Assembly: Syncfusion.Blazor.dll

Syntax

public class PivotChartLegendSettings : OwningComponentBase

Constructors

PivotChartLegendSettings()

Declaration

public PivotChartLegendSettings()

Properties

Alignment

Allows to set the 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 PivotChartAlignment Alignment { get; set; }

Property Value

Type
PivotChartAlignment

Background

Allows to set 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
System.String

Border

Allows options to customize the border of the legend.

Declaration

public PivotChartLegendBorder Border { get; set; }

Property Value

Type
PivotChartLegendBorder

Description

Allows to set the description for legends.

Declaration

public string Description { get; set; }

Property Value

Type
System.String

Height

Allows to set the height of the legend in pixels.

Declaration

public string Height { get; set; }

Property Value

Type
System.String

Location

Allows to set 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 object Location { get; set; }

Property Value

Type
System.Object

Margin

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

Declaration

public PivotChartLegendMargin Margin { get; set; }

Property Value

Type
PivotChartLegendMargin

Opacity

Allows to set the opacity of the legend.

Declaration

public double Opacity { get; set; }

Property Value

Type
System.Double

Padding

Allows option to customize the padding between legend items.

Declaration

public int Padding { get; set; }

Property Value

Type
System.Int32

Position

Allows to set the position of the legend in the chart are, Auto: Places the legend based on area type. Bottom: Displays the legend at the bottom of the chart. Top: Displays the legend at the top of the chart. Left: Displays the legend at the left 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 PivotChartLegendPosition Position { get; set; }

Property Value

Type
PivotChartLegendPosition

ShapeHeight

Allows to set the shape height of the legend in pixels.

Declaration

public int ShapeHeight { get; set; }

Property Value

Type
System.Int32

ShapePadding

Allows to set the padding between the legend shape and text.

Declaration

public int ShapePadding { get; set; }

Property Value

Type
System.Int32

ShapeWidth

Allows to set the shape width of the legend in pixels.

Declaration

public int ShapeWidth { get; set; }

Property Value

Type
System.Int32

TabIndex

Allows to set the tabindex value for the legend.

Declaration

public double TabIndex { get; set; }

Property Value

Type
System.Double

TextStyle

Allows options to customize the legend text.

Declaration

public PivotChartLegendTextStyle TextStyle { get; set; }

Property Value

Type
PivotChartLegendTextStyle

ToggleVisibility

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

Declaration

public bool ToggleVisibility { get; set; }

Property Value

Type
System.Boolean

Visible

If set to true, legend will be visible.

Declaration

public Nullable<bool> Visible { get; set; }

Property Value

Type
System.Nullable<System.Boolean>

Width

Allows to set the width of the legend in pixels.

Declaration

public string Width { get; set; }

Property Value

Type
System.String

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

Dispose(Boolean)

Dispose unmanaged resources in the component.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

OnInitializedAsync()

Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree. Override this method if you will perform an asynchronous operation and want the component to refresh when that operation is completed.

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing any asynchronous operation.

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing any asynchronous operation.