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
Namespace: Syncfusion.Blazor.PivotView
Assembly: Syncfusion.Blazor.dll
Syntax
public class PivotChartPrimaryYAxis : OwningComponentBase
Constructors
PivotChartPrimaryYAxis()
Declaration
public PivotChartPrimaryYAxis()
Properties
Border
Allows to set the border of the multi level labels.
Declaration
public PivotChartPrimaryYAxisBorder Border { get; set; }
Property Value
Type |
---|
PivotChartPrimaryYAxisBorder |
Coefficient
Allows to set the polar radar radius position.
Declaration
public double Coefficient { get; set; }
Property Value
Type |
---|
System.Double |
CrosshairTooltip
Allows options to customize the crosshair ToolTip.
Declaration
public PivotChartPrimaryYAxisCrosshairTooltip CrosshairTooltip { get; set; }
Property Value
Type |
---|
PivotChartPrimaryYAxisCrosshairTooltip |
Description
Allows to set the description for axis and its element.
Declaration
public string Description { get; set; }
Property Value
Type |
---|
System.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
public PivotChartEdgeLabelPlacement EdgeLabelPlacement { get; set; }
Property Value
Type |
---|
PivotChartEdgeLabelPlacement |
EnableTrim
Allows to set the Trim property for an axis.
Declaration
public bool EnableTrim { get; set; }
Property Value
Type |
---|
System.Boolean |
Interval
Allows to set the interval for an axis.
Declaration
public double Interval { get; set; }
Property Value
Type |
---|
System.Double |
IsIndexed
Allows to specify the indexed category to the axis.
Declaration
public bool IsIndexed { get; set; }
Property Value
Type |
---|
System.Boolean |
IsInversed
Allows to specify whether the axis to be rendered in inversed manner or not.
Declaration
public bool IsInversed { get; set; }
Property Value
Type |
---|
System.Boolean |
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
public string LabelFormat { get; set; }
Property Value
Type |
---|
System.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
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
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
public PivotChartAxisPosition LabelPosition { get; set; }
Property Value
Type |
---|
PivotChartAxisPosition |
LabelRotation
Allows to set the angle to which the axis label gets rotated.
Declaration
public double LabelRotation { get; set; }
Property Value
Type |
---|
System.Double |
LabelStyle
Allows options to customize the axis label.
Declaration
public PivotChartPrimaryYAxisFont LabelStyle { get; set; }
Property Value
Type |
---|
PivotChartPrimaryYAxisFont |
LineStyle
Allows options for customizing axis lines.
Declaration
public PivotChartPrimaryYAxisLineStyle LineStyle { get; set; }
Property Value
Type |
---|
PivotChartPrimaryYAxisLineStyle |
MajorGridLines
Allows options for customizing major grid lines.
Declaration
public PivotChartPrimaryYAxisMajorGridLines MajorGridLines { get; set; }
Property Value
Type |
---|
PivotChartPrimaryYAxisMajorGridLines |
MajorTickLines
Allows options for customizing major tick lines.
Declaration
public PivotChartPrimaryYAxisMajorTickLines MajorTickLines { get; set; }
Property Value
Type |
---|
PivotChartPrimaryYAxisMajorTickLines |
Maximum
Allows to set the maximum range of an axis.
Declaration
public object Maximum { get; set; }
Property Value
Type |
---|
System.Object |
MaximumLabelWidth
Allows to set the maximum width of an axis label.
Declaration
public int MaximumLabelWidth { get; set; }
Property Value
Type |
---|
System.Int32 |
Minimum
Allows to set the minimum range of an axis.
Declaration
public object Minimum { get; set; }
Property Value
Type |
---|
System.Object |
MinorGridLines
Allows options for customizing minor grid lines.
Declaration
public PivotChartPrimaryYAxisMinorGridLines MinorGridLines { get; set; }
Property Value
Type |
---|
PivotChartPrimaryYAxisMinorGridLines |
MinorTickLines
Allows options for customizing minor tick lines.
Declaration
public PivotChartPrimaryYAxisMinorTickLines MinorTickLines { get; set; }
Property Value
Type |
---|
PivotChartPrimaryYAxisMinorTickLines |
MinorTicksPerInterval
Allows to set the number of minor ticks per interval.
Declaration
public double MinorTicksPerInterval { get; set; }
Property Value
Type |
---|
System.Double |
OpposedPosition
If set to true, the axis will render at the opposite side of its default position.
Declaration
public bool OpposedPosition { get; set; }
Property Value
Type |
---|
System.Boolean |
PlotOffset
Allows to set the left and right padding for the plot area in pixels.
Declaration
public int PlotOffset { get; set; }
Property Value
Type |
---|
System.Int32 |
StartAngle
Allows to set the start angle for the series.
Declaration
public int StartAngle { get; set; }
Property Value
Type |
---|
System.Int32 |
StripLines
Allows to set the stripLine collection for the axis.
Declaration
public List<PivotChartPrimaryYAxisStripLineSetting> StripLines { get; set; }
Property Value
Type |
---|
System.Collections.Generic.List<PivotChartPrimaryYAxisStripLineSetting> |
TabIndex
Allows to set the tabindex value for the axis.
Declaration
public double TabIndex { get; set; }
Property Value
Type |
---|
System.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
public PivotChartAxisPosition TickPosition { get; set; }
Property Value
Type |
---|
PivotChartAxisPosition |
Title
Allows to set the title of an axis.
Declaration
public string Title { get; set; }
Property Value
Type |
---|
System.String |
TitleStyle
Allows options for customizing the axis title.
Declaration
public PivotChartPrimaryYAxisTitleStyle TitleStyle { get; set; }
Property Value
Type |
---|
PivotChartPrimaryYAxisTitleStyle |
Visible
If set to true, axis label will be visible.
Declaration
public bool Visible { get; set; }
Property Value
Type |
---|
System.Boolean |
ZoomFactor
Allows to set the zoom factor for axis.
Declaration
public Nullable<double> ZoomFactor { get; set; }
Property Value
Type |
---|
System.Nullable<System.Double> |
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. |