Class Chart3DAxisBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
Chart3DAxisBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class Chart3DAxisBuilder : ControlBuilder
Constructors
Chart3DAxisBuilder()
Declaration
public Chart3DAxisBuilder()
Chart3DAxisBuilder(Chart3DAxis)
Declaration
public Chart3DAxisBuilder(Chart3DAxis model)
Parameters
Chart3DAxisBuilder(List<Chart3DAxis>)
Declaration
public Chart3DAxisBuilder(List<Chart3DAxis> collection)
Parameters
Type |
Name |
Description |
System.Collections.Generic.List<Chart3DAxis> |
collection |
|
Methods
Add()
Declaration
ColumnIndex(Double)
Specifies the index of the column where the axis is associated,
when the chart area is divided into multiple plot areas by using columns
.
Declaration
public Chart3DAxisBuilder ColumnIndex(double columnIndex)
Parameters
Type |
Name |
Description |
System.Double |
columnIndex |
|
Returns
DesiredIntervals(Double)
With this property, you can request axis to calculate intervals approximately equal to your specified interval.
Declaration
public Chart3DAxisBuilder DesiredIntervals(double desiredIntervals)
Parameters
Type |
Name |
Description |
System.Double |
desiredIntervals |
|
Returns
EdgeLabelPlacement(EdgeLabelPlacement)
Specifies the position of labels at the edge of the axis.They are,
None: No action will be performed.
Hide: Edge label will be hidden.
Shift: Shifts the edge labels.
Declaration
public Chart3DAxisBuilder EdgeLabelPlacement(EdgeLabelPlacement edgeLabelPlacement)
Parameters
Returns
EnableTrim(Boolean)
Specifies the Trim property for an axis.
Declaration
public Chart3DAxisBuilder EnableTrim(bool enableTrim)
Parameters
Type |
Name |
Description |
System.Boolean |
enableTrim |
|
Returns
Interval(Double)
Specifies the interval for an axis.
Declaration
public Chart3DAxisBuilder Interval(double interval)
Parameters
Type |
Name |
Description |
System.Double |
interval |
|
Returns
IntervalType(IntervalType)
Specifies the types like Years
, Months
, Days
, Hours
, Minutes
, Seconds
in date time axis.They are,
Auto: Defines the interval of the axis based on 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.
Declaration
public Chart3DAxisBuilder IntervalType(IntervalType intervalType)
Parameters
Returns
IsIndexed(Boolean)
Specifies indexed category axis.
Declaration
public Chart3DAxisBuilder IsIndexed(bool isIndexed)
Parameters
Type |
Name |
Description |
System.Boolean |
isIndexed |
|
Returns
IsInversed(Boolean)
It specifies whether the axis to be rendered in inversed manner or not.
Declaration
public Chart3DAxisBuilder IsInversed(bool isInversed)
Parameters
Type |
Name |
Description |
System.Boolean |
isInversed |
|
Returns
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 Chart3DAxisBuilder LabelFormat(string labelFormat)
Parameters
Type |
Name |
Description |
System.String |
labelFormat |
|
Returns
LabelIntersectAction(LabelIntersectAction)
Specifies the actions like None
, Hide
, Trim
, Wrap
, MultipleRows
, Rotate45
, and Rotate90
when the axis labels intersect with each other.They are,
None: Shows all the labels.
Hide: Hides the label when it intersects.
Trim: Trim the label when it intersects.
Wrap: Wrap the label when it intersects.
MultipleRows: Shows the label in MultipleRows when it intersects.
Rotate45: Rotates the label to 45 degree when it intersects.
Rotate90: Rotates the label to 90 degree when it intersects.
Declaration
public Chart3DAxisBuilder LabelIntersectAction(LabelIntersectAction labelIntersectAction)
Parameters
Returns
LabelPadding(Double)
Specifies the labelPadding from axis.
Declaration
public Chart3DAxisBuilder LabelPadding(double labelPadding)
Parameters
Type |
Name |
Description |
System.Double |
labelPadding |
|
Returns
LabelPlacement(LabelPlacement)
Specifies the placement of a label for category axis. They are,
betweenTicks: Renders the label between the ticks.
onTicks: Renders the label on the ticks.
Declaration
public Chart3DAxisBuilder LabelPlacement(LabelPlacement labelPlacement)
Parameters
Returns
LabelRotation(Double)
The angle to which the axis label gets rotated.
Declaration
public Chart3DAxisBuilder LabelRotation(double labelRotation)
Parameters
Type |
Name |
Description |
System.Double |
labelRotation |
|
Returns
LabelStyle(Chart3DTextFont)
Options to customize the axis label.
Declaration
public Chart3DAxisBuilder LabelStyle(Chart3DTextFont labelStyle)
Parameters
Returns
LabelStyle(Action<Chart3DTextFontBuilder>)
Declaration
public Chart3DAxisBuilder LabelStyle(Action<Chart3DTextFontBuilder> labelStyle)
Parameters
Returns
LogBase(Double)
The base value for logarithmic axis. It requires valueType
to be Logarithmic
.
Declaration
public Chart3DAxisBuilder LogBase(double logBase)
Parameters
Type |
Name |
Description |
System.Double |
logBase |
|
Returns
MajorGridLines(Chart3DMajorGridLines)
Options for customizing major grid lines.
Declaration
public Chart3DAxisBuilder MajorGridLines(Chart3DMajorGridLines majorGridLines)
Parameters
Returns
MajorGridLines(Action<Chart3DMajorGridLinesBuilder>)
Declaration
public Chart3DAxisBuilder MajorGridLines(Action<Chart3DMajorGridLinesBuilder> majorGridLines)
Parameters
Returns
MajorTickLines(Chart3DMajorTickLines)
Options for customizing major tick lines.
Declaration
public Chart3DAxisBuilder MajorTickLines(Chart3DMajorTickLines majorTickLines)
Parameters
Returns
MajorTickLines(Action<Chart3DMajorTickLinesBuilder>)
Declaration
public Chart3DAxisBuilder MajorTickLines(Action<Chart3DMajorTickLinesBuilder> majorTickLines)
Parameters
Returns
Maximum(Object)
Specifies the maximum range of an axis.
Declaration
public Chart3DAxisBuilder Maximum(object maximum)
Parameters
Type |
Name |
Description |
System.Object |
maximum |
|
Returns
MaximumLabels(Double)
The maximum number of label count per 100 pixels with respect to the axis length.
Declaration
public Chart3DAxisBuilder MaximumLabels(double maximumLabels)
Parameters
Type |
Name |
Description |
System.Double |
maximumLabels |
|
Returns
MaximumLabelWidth(Double)
Specifies the maximum width of an axis label.
Declaration
public Chart3DAxisBuilder MaximumLabelWidth(double maximumLabelWidth)
Parameters
Type |
Name |
Description |
System.Double |
maximumLabelWidth |
|
Returns
Minimum(Object)
Specifies the minimum range of an axis.
Declaration
public Chart3DAxisBuilder Minimum(object minimum)
Parameters
Type |
Name |
Description |
System.Object |
minimum |
|
Returns
MinorGridLines(Chart3DMinorGridLines)
Options for customizing minor grid lines.
Declaration
public Chart3DAxisBuilder MinorGridLines(Chart3DMinorGridLines minorGridLines)
Parameters
Returns
MinorGridLines(Action<Chart3DMinorGridLinesBuilder>)
Declaration
public Chart3DAxisBuilder MinorGridLines(Action<Chart3DMinorGridLinesBuilder> minorGridLines)
Parameters
Returns
MinorTickLines(Chart3DMinorTickLines)
Options for customizing minor tick lines.
Declaration
public Chart3DAxisBuilder MinorTickLines(Chart3DMinorTickLines minorTickLines)
Parameters
Returns
MinorTickLines(Action<Chart3DMinorTickLinesBuilder>)
Declaration
public Chart3DAxisBuilder MinorTickLines(Action<Chart3DMinorTickLinesBuilder> minorTickLines)
Parameters
Returns
MinorTicksPerInterval(Double)
Specifies the number of minor ticks per interval.
Declaration
public Chart3DAxisBuilder MinorTicksPerInterval(double minorTicksPerInterval)
Parameters
Type |
Name |
Description |
System.Double |
minorTicksPerInterval |
|
Returns
Name(String)
Unique identifier of an axis.
To associate an axis with the series, set this name to the xAxisName/yAxisName properties of the series.
Declaration
public Chart3DAxisBuilder Name(string name)
Parameters
Type |
Name |
Description |
System.String |
name |
|
Returns
OpposedPosition(Boolean)
If set to true, the axis will render at the opposite side of its default position.
Declaration
public Chart3DAxisBuilder OpposedPosition(bool opposedPosition)
Parameters
Type |
Name |
Description |
System.Boolean |
opposedPosition |
|
Returns
PlotOffset(Double)
Left and right padding for the plot area in pixels.
Declaration
public Chart3DAxisBuilder PlotOffset(double plotOffset)
Parameters
Type |
Name |
Description |
System.Double |
plotOffset |
|
Returns
PlotOffsetBottom(Double)
Bottom padding for the plot area in pixels.
Declaration
public Chart3DAxisBuilder PlotOffsetBottom(double plotOffsetBottom)
Parameters
Type |
Name |
Description |
System.Double |
plotOffsetBottom |
|
Returns
PlotOffsetLeft(Double)
Left padding for the plot area in pixels.
Declaration
public Chart3DAxisBuilder PlotOffsetLeft(double plotOffsetLeft)
Parameters
Type |
Name |
Description |
System.Double |
plotOffsetLeft |
|
Returns
PlotOffsetRight(Double)
Right padding for the plot area in pixels.
Declaration
public Chart3DAxisBuilder PlotOffsetRight(double plotOffsetRight)
Parameters
Type |
Name |
Description |
System.Double |
plotOffsetRight |
|
Returns
PlotOffsetTop(Double)
Top padding for the plot area in pixels.
Declaration
public Chart3DAxisBuilder PlotOffsetTop(double plotOffsetTop)
Parameters
Type |
Name |
Description |
System.Double |
plotOffsetTop |
|
Returns
RangePadding(ChartRangePadding)
Specifies the padding for the axis range in terms of interval.They are,
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 divided by the interval.
Declaration
public Chart3DAxisBuilder RangePadding(ChartRangePadding rangePadding)
Parameters
Returns
RowIndex(Double)
Specifies the index of the row where the axis is associated, when the chart area is divided into multiple plot areas by using rows
.
Declaration
public Chart3DAxisBuilder RowIndex(double rowIndex)
Parameters
Type |
Name |
Description |
System.Double |
rowIndex |
|
Returns
Skeleton(String)
Specifies the skeleton format in which the dateTime format will process.
Declaration
public Chart3DAxisBuilder Skeleton(string skeleton)
Parameters
Type |
Name |
Description |
System.String |
skeleton |
|
Returns
SkeletonType(SkeletonType)
It specifies the type of format to be used in dateTime format process.
Declaration
public Chart3DAxisBuilder SkeletonType(SkeletonType skeletonType)
Parameters
Returns
Span(Double)
Specifies the number of columns
or rows
an axis has to span horizontally or vertically.
Declaration
public Chart3DAxisBuilder Span(double span)
Parameters
Type |
Name |
Description |
System.Double |
span |
|
Returns
StartFromZero(Boolean)
It specifies whether the axis to be start from zero.
Declaration
public Chart3DAxisBuilder StartFromZero(bool startFromZero)
Parameters
Type |
Name |
Description |
System.Boolean |
startFromZero |
|
Returns
Title(String)
Specifies the title of an axis.
Declaration
public Chart3DAxisBuilder Title(string title)
Parameters
Type |
Name |
Description |
System.String |
title |
|
Returns
TitlePadding(Double)
Specifies the titlePadding from axis label.
Declaration
public Chart3DAxisBuilder TitlePadding(double titlePadding)
Parameters
Type |
Name |
Description |
System.Double |
titlePadding |
|
Returns
TitleRotation(Double)
Defines an angle to rotate axis title. By default, angle auto calculated based on position and orientation of axis.
Declaration
public Chart3DAxisBuilder TitleRotation(double titleRotation)
Parameters
Type |
Name |
Description |
System.Double |
titleRotation |
|
Returns
TitleStyle(Chart3DTextFont)
Options for customizing the axis title.
Declaration
public Chart3DAxisBuilder TitleStyle(Chart3DTextFont titleStyle)
Parameters
Returns
TitleStyle(Action<Chart3DTextFontBuilder>)
Declaration
public Chart3DAxisBuilder TitleStyle(Action<Chart3DTextFontBuilder> titleStyle)
Parameters
Returns
ValueType(ValueType)
Specifies the data types that the axis can handle:
Double: This type is used for rendering a numeric axis to accommodate numeric data.
DateTime: This type is utilized for rendering a date-time axis to manage date-time data.
Category: This type is employed for rendering a category axis to manage categorical data.
Logarithmic: This type is applied for rendering a logarithmic axis to handle a wide range of values.
DateTimeCategory: This type is used to render a date time category axis for managing business days.
Declaration
public Chart3DAxisBuilder ValueType(ValueType valueType)
Parameters
Returns
Visible(Boolean)
If set to true, axis label will be visible.
Declaration
public Chart3DAxisBuilder Visible(bool visible)
Parameters
Type |
Name |
Description |
System.Boolean |
visible |
|
Returns