Class Chart3DAxis

Gets or sets instance of Chart3DAxis which is used to customize the primary x-axis of the 3D Chart.

Inheritance

object

ComponentBase

OwningComponentBase

SfOwningComponentBase

Chart3DSubComponent

Chart3DAxis

Chart3DPrimaryXAxis

Chart3DPrimaryYAxis

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

Inherited Members

ComponentBase.Assets

ComponentBase.AssignedRenderMode

ComponentBase.BuildRenderTree(RenderTreeBuilder)

ComponentBase.DispatchExceptionAsync(Exception)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.OnAfterRender(bool)

ComponentBase.OnAfterRenderAsync(bool)

ComponentBase.OnInitialized()

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSet()

ComponentBase.OnParametersSetAsync()

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.Dispose(bool)

OwningComponentBase.IsDisposed

OwningComponentBase.ScopedServices

Namespace: Syncfusion.Blazor.Chart3D

Assembly: Syncfusion.Blazor.dll

Syntax

public class Chart3DAxis : Chart3DSubComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Remarks

By using this class we can add multiple axes to the 3D Chart. Each axis can be customized with different properties. This is child component of Chart3DAxes.

Examples

 <SfChart3D>
    <Chart3DAxes>
        <Chart3DAxis ValueType = "Syncfusion.Blazor.Chart3D.ValueType.Category" RowIndex="0" ColumnIndex="0" Name="XAxis"></Chart3DAxis>
    </Chart3DAxes>

    <Chart3DSeriesCollection>
        <Chart3DSeries XName = "Browser" YName="Users" XAxisName="XAxis" DataSource="@StatisticsDetails" Type="Chart3DSeriesType.Column">
        </Chart3DSeries>
    </Chart3DSeriesCollection>
</SfChart3D>
@code {
    public class Statistics
    {
        public string Browser { get; set; }
        public double Users { get; set; }
    }

    public List<Statistics> StatisticsDetails = new List<Statistics>
    {
        new Statistics { Browser = "Chrome", Users = 65.3 },
        new Statistics { Browser = "Safari", Users = 18.3},
        new Statistics { Browser = "Edge", Users = 5},
        new Statistics { Browser = "Firefox", Users = 3},
        new Statistics { Browser = "Samsung Internet", Users = 2.6},
        new Statistics { Browser = “Opera”, Users = 2.4},
    };
}

Constructors

Chart3DAxis()

Declaration

public Chart3DAxis()

Properties

ColumnIndex

Gets or sets the index of the column with which the axis is associated.

Declaration

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

Property Value

Type	Description
double	The index of the column associated with the axis. The default value is 0.

Remarks

This property is applicable only when the 3D Chart area is divided into multiple plot areas using the Chart3DColumns. To bind a horizonatal axis to a specific column, set the axis’s ColumnIndex property to that column’s index.

DesiredIntervals

Gets or sets a value that indicates the approximate interval count for axis interval calculation.

Declaration

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

Property Value

Type	Description
double	The desired interval counts for axis interval calculation. The default value is NaN.

Remarks

Not applicable when ValueType of the axis is ValueType.Category.

EdgeLabelPlacement

Gets or sets the placement of labels at the edge of the axis.

Declaration

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

Property Value

Type	Description
EdgeLabelPlacement	One of the EdgeLabelPlacement enumerations that specify the edge label placement for the axis. Options include: None: No action will be performed, and the label will be rendered as it is. Hide: Hides the edge label if it exceeds the SfChart3D area. Shift: Shifts the edge labels within the SfChart3D area. The default mode is None.

Remarks

The longer text labels at the axis edges may only be partially visible in the SfChart3D. Utilize this property to place the edge labels efficiently for a better user experience.

EnableTrim

Gets or sets a value indicating whether axis labels should be trimmed when they exceed the MaximumLabelWidth.

Declaration

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

Property Value

Type	Description
bool	true if axis labels should be trimmed; otherwise, false. The default value is false.

Remarks

If set to true, axis labels which exceed the MaximumLabelWidth will be trimmed regardless of the LabelIntersectAction applied.

Format

Gets or sets the date format for the DateTime and DateTimeCategory axis.

Declaration

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

Property Value

Type	Description
string	Accepts the valid date format string to format the axis labels. The default value is system default date format.

Remarks

By using this property, the axis labels can be formatted with the desired date format. If no format is specified, the axis labels will be formatted based on the datasource ranges.

Interval

Gets or sets the interval for the axis.

Declaration

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

Property Value

Type	Description
double	The numeric value representing the interval for the axis. The default value is NaN.

Remarks

The interval can be customized using IntervalType for DateTime-based axis and LogBase for logarithmic-based axis. For example, if the interval is set to 2 and the IntervalType is set to Years, it considers 2 years to be the interval.

IntervalType

Gets or sets the interval type for DateTime-based data on the axis.

Declaration

[Parameter]
public IntervalType IntervalType { get; set; }

Property Value

Type

Description

IntervalType

One of the IntervalType enumerations that specifies the interval type for the DateTime-based axis. Options include: Auto: Defines the interval of the axis based on the data. Years: Defines the interval of the axis in years. Months: Defines the interval of the axis in months. Days: Defines the interval of the axis in days. Hours: Defines the interval of the axis in hours. Minutes: Defines the interval of the axis in minutes. The default value is Auto.

Remarks

Use this property to specify the interval type for DateTime-based data on the axis. The interval type determines how the axis labels are displayed.

IsIndexed

Gets or sets a value indicating whether the category axis should be rendered using the data source index values.

Declaration

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

Property Value

Type	Description
bool	true if the category axis should be rendered based on the data source index values; otherwise, false. The default value is false.

Remarks

If set to true, multiple series will be rendered based on their data source index values.

IsInversed

Gets or sets a value indicating whether the axis should be rendered in an inversed manner.

Declaration

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

Property Value

Type	Description
bool	true if the axis should be rendered in an inversed manner; otherwise, false. The default value is false.

Remarks

If set to true, the axis will be rendered with the greatest value on the axis moving closer to the origin, and vice versa.

LabelFormat

Gets or sets a value that is used to format the numeric, logarithmic, and datetime labels to all globalized formats. Axis also supports custom label format using placeholders such as {value}K, where the value represents the axis label.

Declaration

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

Property Value

Type	Description
string	A string representing the format for processing numeric, logarithmic, and datetime labels.

Remarks

This property is used to globalize the numeric, logarithmic, and datetime labels value of the elements such as Axis label, Data label, and Tooltip in the 3D Chart component. This property is not applicable to Category axis.

LabelIntersectAction

Gets or sets a value that specifies how to arrange axis labels intelligently when they intersect with each other.

Declaration

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

Property Value

Type

Description

LabelIntersectAction

One of the LabelIntersectAction enumerations that specifies the alignment of axis labels when they intersect. Options include: None: Show all labels, regardless of intersections. Hide: Hide labels that intersect with each other. Trim: Trim labels to fit within the available space when they intersect. Wrap: Wrap labels to multiple lines when they intersect. MultipleRows: Display labels in multiple rows when they intersect. Rotate45: Rotate labels by 45 degrees when they intersect. Rotate90: Rotate labels by 90 degrees when they intersect. The default LabelIntersectAction is Trim.

Remarks

Note: For the vertical axis, the Hide option is the only applicable choice.

LabelPadding

Gets or sets the padding for axis labels from the axis line in pixels.

Declaration

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

Property Value

Type	Description
double	The numeric value representing the label padding from the axis line in pixels. The default value is 5.

Remarks

This property specifies the padding between axis labels and the axis line. It is measured in pixels.

LabelPlacement

Gets or sets a value that specifies the placement of axis labels with respect to the axis tick lines.

Declaration

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

Property Value

Type	Description
LabelPlacement	One of the LabelPlacement enumerations that specifies the placement for the axis labels. Options include: BetweenTicks: Renders the label between the ticks. OnTicks: Renders the label on the ticks. The default value is OnTicks.

LabelRotationAngle

Gets or sets the angle to which the axis labels get rotated.

Declaration

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

Property Value

Type	Description
double	The numeric value representing the rotation angle of the axis labels. The default value is 0.

Remarks

This property specifies the rotation angle applied to axis labels, enhancing their orientation for better readability. It accepts numerical values from 0 to 360, with negative values representing angles calculated from 360.

LogBase

Gets or sets the base value for logarithmic axis.

Declaration

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

Property Value

Type	Description
double	Accepts the double value for logarithmic axis. The default value is 10.

Remarks

This property is applicable only for the logarithmic axis.

Maximum

Gets or sets the maximum range of an axis.

Declaration

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

Property Value

Type	Description
object	The value representing the maximum range of an axis. The default value is derived from the values of corresponding data source points.

Remarks

This property specifies the maximum range for the axis. It determines the upper limit of the visible range on the axis.

MaximumLabelWidth

Gets or sets the maximum width for an axis label.

Declaration

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

Property Value

Type	Description
double	The numeric value representing the maximum width for an axis label. The default value is 34.

Remarks

If EnableTrim is set to true, axis labels which exceed the MaximumLabelWidth will be trimmed.

MaximumLabels

Gets or sets the maximum number of labels per 100 pixels with respect to the axis length.

Declaration

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

Property Value

Type	Description
double	The numeric value representing the maximum label count. The default value is 3.

Remarks

Accepts the values in numerical forms.

Minimum

Gets or sets the minimum range of an axis.

Declaration

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

Property Value

Type	Description
object	The value representing the minimum range of an axis. The default value is derived from the values of corresponding data source points.

Remarks

This property specifies the minimum range for the axis. It determines the lower limit of the visible range on the axis.

MinorTicksPerInterval

Gets or sets the number of minor ticks to be rendered per interval.

Declaration

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

Property Value

Type	Description
double	The numeric value representing the number of minor ticks per interval.

Remarks

Note: Minor grid lines and minor tick lines will be rendered only when this property is provided with a value greater than zero.

Name

Gets or sets the unique identifier name of an axis.

Declaration

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

Property Value

Type	Description
string	A string representing the unique identifier name of the axis. The default value is an empty string.

Remarks

To associate an axis with the series, set this name to the XAxisName or YAxisName properties of the series.

OpposedPosition

Gets or sets a value indicating whether to place an axis in the opposite position of its original position.

Declaration

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

Property Value

Type	Description
bool	true if the axis should render at the opposite position; otherwise, false. The default value is false.

Remarks

For a horizontal axis, setting OpposedPosition to true will position the axis at the top of the 3D Chart. For a vertical axis, setting OpposedPosition to true will position the axis at the right side of the 3D Chart.

PlotOffset

Gets or sets the padding for the plot area in pixels for the 3D Chart axis.

Declaration

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

Property Value

Type	Description
double	Accepts the double values in pixels. The default value is 0.

Remarks

This property specifies the padding between the axis and the plot area in the 3D Chart. It is measured in pixels.

PlotOffsetBottom

Gets or sets the bottom padding for the plot area in pixels for the 3D Chart axis.

Declaration

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

Property Value

Type	Description
double	Accepts the double values in pixels. The default value is double.NaN.

Remarks

This property specifies the bottom padding between the axis and the plot area in the 3D Chart. It is measured in pixels. Use double.NaN for automatic calculation.

PlotOffsetLeft

Gets or sets the left padding for the plot area in pixels for the 3D Chart axis.

Declaration

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

Property Value

Type	Description
double	Accepts the double values in pixels. The default value is double.NaN.

Remarks

This property specifies the left padding between the axis and the plot area in the 3D Chart. It is measured in pixels. Use double.NaN for automatic calculation.

PlotOffsetRight

Gets or sets the right padding for the plot area in pixels for the 3D Chart axis.

Declaration

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

Property Value

Type	Description
double	Accepts the double values in pixels. The default value is double.NaN.

Remarks

This property specifies the right padding between the axis and the plot area in the 3D Chart. It is measured in pixels. Use double.NaN for automatic calculation.

PlotOffsetTop

Gets or sets the top padding for the plot area in pixels for the 3D Chart axis.

Declaration

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

Property Value

Type	Description
double	Accepts the double values in pixels. The default value is double.NaN.

Remarks

This property specifies the top padding between the axis and the plot area in the 3D Chart . It is measured in pixels. Use double.NaN for automatic calculation.

RangePadding

Gets or sets a value that specifies the padding for the axis range in terms of interval.

Declaration

[Parameter]
public ChartRangePadding RangePadding { get; set; }

Property Value

Type

Description

ChartRangePadding

One of the ChartRangePadding enumerations that specifies the range padding of the axis. The options include: Auto: Padding is applied based on the axis orientation. None: Padding cannot be applied to the axis. Normal: Padding is applied to the axis based on the range calculation. Additional: Interval of the axis is added as padding to the minimum and maximum values of the range. Round: Axis range is rounded to the nearest possible value divisible by the interval. The default value is Auto.

Remarks

When the RangePadding is set to Auto, the padding is applied based on the axis orientation.

RowIndex

Gets or sets a value that specifies the index of the row with which the axis is associated.

Declaration

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

Property Value

Type	Description
double	A numeric value representing the index of the row associated with the axis. The default value is 0.

Remarks

This property is applicable only when the 3D Chart area is divided into multiple plot areas using Chart3DRows. To bind a vertical axis to a specific row, set the axis’s RowIndex property to that row’s index.

Span

Specifies the number of columns or rows the axis must span horizontally or vertically.

Declaration

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

Property Value

Type	Description
int	An integer representing the number of columns or rows the axis spans. The default value is 1.

Remarks

This property is applicable only when the 3D Chart area is divided into multiple panes using Chart3DRows or Chart3DColumns.

StartFromZero

Gets or sets a value indicating whether the numeric axis should start from zero.

Declaration

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

Property Value

Type	Description
bool	true if the numeric axis starts from zero; otherwise, false. The default value is true.

Remarks

This property is only applicable for numeric axes.

Title

Gets or sets the title of an axis.

Declaration

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

Property Value

Type	Description
string	A string representing the title of the axis. The default value is an empty string.

Remarks

The axis title provides quick information to the user about the data plotted in the axis.

TitlePadding

Gets or sets the padding for axis title from the axis labels in pixels.

Declaration

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

Property Value

Type	Description
double	The numeric value representing the title padding from the axis labels in pixels. The default value is 5.

Remarks

The numeric value representing the title padding from the axis labels in pixels. The default value is 5.

TitleRotationAngle

Gets or sets the angle to which the axis title gets rotated.

Declaration

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

Property Value

Type	Description
double	Accepts the double value representing the rotation angle of the axis title. The default value is 0.

Remarks

This property specifies the rotation angle applied to the axis title, enhancing its orientation for better readability. It accepts numerical values from 0 to 360, with negative values representing angles calculated from 360.

ValueType

Gets or sets the type of data the axis is handling.

Declaration

[Parameter]
public ValueType ValueType { get; set; }

Property Value

Type	Description
ValueType	One of the ValueType enumerations that specifies the value type of the axis. Options include: Double: Renders a numeric axis. DateTime: Renders a date time axis. Category: Renders a category axis. Logarithmic: Renders a logarithmic axis. DateTimeCategory: Renders a date time category axis. The default value is Double.

Remarks

This property determines the type of data the axis is handling, affecting how axis values are interpreted and displayed on the SfChart3D. It is essential to set this property correctly based on the nature of the data being plotted.

Visible

Gets or sets a value indicating whether the axis elements such as axis labels, tick lines, grid lines, and axis title should be visible.

Declaration

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

Property Value

Type	Description
bool	true if the axis and its associated elements are visible; otherwise, false. The default value is true.

Remarks

Set this property to control the visibility of various axis elements. When set to false, the axis and its associated elements will not be rendered on the 3D Chart.

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable