Class PivotChartPrimaryYAxis

Allow options to customize the vertical(value) axis with different properties such as labelIntersectAction, labelStyle, title, description, crosshairTooltip, labelFormat, titleStyle, plotOffset, edgeLabelPlacement, labelPlacement, tickPosition, opposedPosition, minor and major grid lines, minor and major tick lines, border, etc. in the pivot chart.

Inheritance

object

ComponentBase

OwningComponentBase

SfOwningComponentBase

PivotChartPrimaryYAxis

Implements

Inherited Members

ComponentBase.Assets

ComponentBase.AssignedRenderMode

ComponentBase.DispatchExceptionAsync(Exception)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.OnAfterRender(bool)

ComponentBase.OnAfterRenderAsync(bool)

ComponentBase.OnInitialized()

ComponentBase.OnParametersSet()

ComponentBase.RendererInfo

ComponentBase.SetParametersAsync(ParameterView)

ComponentBase.ShouldRender()

ComponentBase.StateHasChanged()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

OwningComponentBase.IsDisposed

OwningComponentBase.ScopedServices

Namespace: Syncfusion.Blazor.PivotView

Assembly: Syncfusion.Blazor.dll

Syntax

public class PivotChartPrimaryYAxis : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

PivotChartPrimaryYAxis()

Declaration

public PivotChartPrimaryYAxis()

Properties

Border

Allows to set the border of the multi level labels.

Declaration

[Parameter]
public PivotChartPrimaryYAxisBorder Border { get; set; }

Property Value

Type
PivotChartPrimaryYAxisBorder

Coefficient

Allows to set the polar radar radius position.

Declaration

[Parameter]
public double Coefficient { get; set; }

Property Value

Type
double

CrosshairTooltip

Allows options to customize the crosshair ToolTip.

Declaration

[Parameter]
public PivotChartPrimaryYAxisCrosshairTooltip CrosshairTooltip { get; set; }

Property Value

Type
PivotChartPrimaryYAxisCrosshairTooltip

Description

Allows to set the description for axis and its element.

Declaration

[Parameter]
public string Description { get; set; }

Property Value

Type
string

EdgeLabelPlacement

Allows to set the position of labels at the edge of the axis.They are, Shift: Shifts the edge labels. None: No action will be performed. Hide: Edge label will be hidden.

Declaration

[Parameter]
public PivotChartEdgeLabelPlacement EdgeLabelPlacement { get; set; }

Property Value

Type
PivotChartEdgeLabelPlacement

EnableTrim

Allows to set the Trim property for an axis.

Declaration

[Parameter]
public bool EnableTrim { get; set; }

Property Value

Type
bool

Interval

Allows to set the interval for an axis.

Declaration

[Parameter]
public double Interval { get; set; }

Property Value

Type
double

IsIndexed

Allows to specify the indexed category to the axis.

Declaration

[Parameter]
public bool IsIndexed { get; set; }

Property Value

Type
bool

IsInversed

Allows to specify whether the axis to be rendered in inversed manner or not.

Declaration

[Parameter]
public bool IsInversed { get; set; }

Property Value

Type
bool

LabelFormat

It used to format the axis label that accepts any global string format like 'C', 'n1', 'P' etc. It also accepts placeholder like '{value}°C' in which value represent the axis label, e.g, 20°C.

Declaration

[Parameter]
public string LabelFormat { get; set; }

Property Value

Type
string

LabelIntersectAction

Allows to set the actions like Hide, Rotate45, and Rotate90 when the axis labels intersect with each other.They are, Rotate45: Rotates the label to 45 degree when it intersects. Rotate90: Rotates the label to 90 degree when it intersects. None: Shows all the labels. Hide: Hides the label when it intersects.

Declaration

[Parameter]
public PivotChartLabelIntersectAction LabelIntersectAction { get; set; }

Property Value

Type
PivotChartLabelIntersectAction

LabelPlacement

Allows to set the placement of a label for category axis. They are, onTicks: Renders the label on the ticks. betweenTicks: Renders the label between the ticks.

Declaration

[Parameter]
public PivotChartLabelPlacement LabelPlacement { get; set; }

Property Value

Type
PivotChartLabelPlacement

LabelPosition

Allows to set the placement of a labels to the axis line. They are, outside: Renders the labels outside to the axis line. inside: Renders the labels inside to the axis line.

Declaration

[Parameter]
public PivotChartAxisPosition LabelPosition { get; set; }

Property Value

Type
PivotChartAxisPosition

LabelRotation

Allows to set the angle to which the axis label gets rotated.

Declaration

[Parameter]
public double LabelRotation { get; set; }

Property Value

Type
double

LabelStyle

Allows options to customize the axis label.

Declaration

[Parameter]
public PivotChartPrimaryYAxisFont LabelStyle { get; set; }

Property Value

Type
PivotChartPrimaryYAxisFont

LineStyle

Allows options for customizing axis lines.

Declaration

[Parameter]
public PivotChartPrimaryYAxisLineStyle LineStyle { get; set; }

Property Value

Type
PivotChartPrimaryYAxisLineStyle

MajorGridLines

Allows options for customizing major grid lines.

Declaration

[Parameter]
public PivotChartPrimaryYAxisMajorGridLines MajorGridLines { get; set; }

Property Value

Type
PivotChartPrimaryYAxisMajorGridLines

MajorTickLines

Allows options for customizing major tick lines.

Declaration

[Parameter]
public PivotChartPrimaryYAxisMajorTickLines MajorTickLines { get; set; }

Property Value

Type
PivotChartPrimaryYAxisMajorTickLines

Maximum

Allows to set the maximum range of an axis.

Declaration

[Parameter]
public object Maximum { get; set; }

Property Value

Type
object

MaximumLabelWidth

Allows to set the maximum width of an axis label.

Declaration

[Parameter]
public int MaximumLabelWidth { get; set; }

Property Value

Type
int

Minimum

Allows to set the minimum range of an axis.

Declaration

[Parameter]
public object Minimum { get; set; }

Property Value

Type
object

MinorGridLines

Allows options for customizing minor grid lines.

Declaration

[Parameter]
public PivotChartPrimaryYAxisMinorGridLines MinorGridLines { get; set; }

Property Value

Type
PivotChartPrimaryYAxisMinorGridLines

MinorTickLines

Allows options for customizing minor tick lines.

Declaration

[Parameter]
public PivotChartPrimaryYAxisMinorTickLines MinorTickLines { get; set; }

Property Value

Type
PivotChartPrimaryYAxisMinorTickLines

MinorTicksPerInterval

Allows to set the number of minor ticks per interval.

Declaration

[Parameter]
public double MinorTicksPerInterval { get; set; }

Property Value

Type
double

OpposedPosition

If set to true, the axis will render at the opposite side of its default position.

Declaration

[Parameter]
public bool OpposedPosition { get; set; }

Property Value

Type
bool

PlotOffset

Allows to set the left and right padding for the plot area in pixels.

Declaration

[Parameter]
public int PlotOffset { get; set; }

Property Value

Type
int

StartAngle

Allows to set the start angle for the series.

Declaration

[Parameter]
public int StartAngle { get; set; }

Property Value

Type
int

StripLines

Allows to set the stripLine collection for the axis.

Declaration

[Parameter]
public List<PivotChartPrimaryYAxisStripLineSetting> StripLines { get; set; }

Property Value

Type
List<PivotChartPrimaryYAxisStripLineSetting>

TabIndex

Allows to set the tabindex value for the axis.

Declaration

[Parameter]
public double TabIndex { get; set; }

Property Value

Type
double

TickPosition

Allows to set the placement of a ticks to the axis line. They are, outside: Renders the ticks outside to the axis line. inside: Renders the ticks inside to the axis line.

Declaration

[Parameter]
public PivotChartAxisPosition TickPosition { get; set; }

Property Value

Type
PivotChartAxisPosition

Title

Allows to set the title of an axis.

Declaration

[Parameter]
public string Title { get; set; }

Property Value

Type
string

TitleStyle

Allows options for customizing the axis title.

Declaration

[Parameter]
public PivotChartPrimaryYAxisTitleStyle TitleStyle { get; set; }

Property Value

Type
PivotChartPrimaryYAxisTitleStyle

Visible

If set to true, axis label will be visible.

Declaration

[Parameter]
public bool Visible { get; set; }

Property Value

Type
bool

ZoomFactor

Allows to set the zoom factor for axis.

Declaration

[Parameter]
[JsonIgnore]
public double? ZoomFactor { get; set; }

Property Value

Type
double?

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
RenderTreeBuilder	__builder

Overrides

ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose(bool)

Dispose unmanaged resources in the component.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

Overrides

OwningComponentBase.Dispose(bool)

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
Task	A System.Threading.Tasks.Task representing any asynchronous operation.

Overrides

ComponentBase.OnInitializedAsync()

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
Task	A System.Threading.Tasks.Task representing any asynchronous operation.

Overrides

ComponentBase.OnParametersSetAsync()

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable